Download OpenAPI specification:Download
The password reset API is only applicable to Flow Builders. For running users, the user identity is managed by the underlying Service (e.g. Salesforce, Box, Google), and therefore user resets should be performed on the underlying system, not within ManyWho. The password reset API requires two separate API calls to complete. The first API call sends the user the password reset notification. The second API call performs the actual password change, based on the token provided in the notification.
If a notification is provided, the redirectUrl property should include two parameters in the
content - one for the notification result ({0}) and one for the reset token ({1}).
The platform will automatically parse the notification result and callbackUri values at these
positions in the content.
The result parameter has the following possible values:
To add the password verification URL to the notification, simply add PASSWORD_URL_HERE to the content of
the message and the platform will replace this with the actual verification callback URL, which will in turn
forward to the redirectUrl.
string The email address of the account to initialize a password reset for |
| notificationMessages | Array of objects (NotificationMessageAPI) The list of notification messages to be sent. |
| reason | string The reason for the notification. Typically, the reason will be provided as the 'subject' for email notifications. |
| redirectUrl | string The Url to redirect the user to once this notification has been processed by the platform. |
Success
{- "notificationMessages": [
- {
- "mediaType": "string",
- "message": "string"
}
], - "reason": "string",
- "redirectUrl": "string"
}Apply the actual password change for an account, using the token generated from the notification callback sent in the "Reset Password" endpoint.
The token is not provided in the notification, but rather the token is provided after the user clicks on the
notification link. The token will either be parsed into the provided redirectUrl (if specified)
or provided in the REST response from a GET request to the notification callback URL provided in the
notification.
| token required | string <uuid> The token that was provided to the user as part of the notification callback |
| password | string The new password to be applied to the flow builder account |
Success
{- "password": "string"
}trueThis endpoint requests the provisioning of a new tenant, and also creates a new user if one doesn't exist with the given email
address. If a value is given for the notification object, then the provisioning email sent to the user will
be overridden with the provided message.
string The email of the user | |
| firstName | string The first name of the user |
| lastName | string The last name of the user |
| notification | object (NotificationRequestAPI) |
| password | string The password for the user |
| tenantName | string The name of the tenant to create |
Success
{- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "notification": {
- "notificationMessages": [
- {
- "mediaType": "string",
- "message": "string"
}
], - "reason": "string",
- "redirectUrl": "string"
}, - "password": "string",
- "tenantName": "string"
}The flow state object provides data about a specific instance of a running flow
A flow state provides in-depth information about how users have interacted with a flow, from the data that has been collected in values, to the path of map elements that were travelled, to the users who have interacted with the flow at the various stages of its execution. Flow state data is only available for active flows that have not yet completed.
This API should also not be used for reporting purposes as we have a separate reporting API and reporting infrastructure.
Get a listing of all the flow states in the current tenant.
| pageSize | integer <int32> Default: 10 The number of states to return |
| page | integer <int32> Default: 1 The current page of states |
| status | string The status of the states to filter by |
| from | string <date-time> An ISO 8601 datetime to filter states from |
| to | string <date-time> An ISO 8601 datetime to filter states until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:30Z",
- "dateModified": "2020-02-18T14:27:30Z",
- "expiresAt": "2020-02-18T14:27:30Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
]
}Delete multiple flow states
An array of IDs of the states to delete
Success
[- "string"
]Load an individual flow state
| id required | string <uuid> The ID of the state to load |
Success
{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:30Z",
- "dateModified": "2020-02-18T14:27:30Z",
- "expiresAt": "2020-02-18T14:27:30Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}Get a listing of all the flow states grouped by flow in the current tenant.
| pageSize | integer <int32> Default: 10 The number of flow states to return |
| page | integer <int32> Default: 1 The current page of flow states |
| orderBy | string Default: "developerName" The column to order the results by |
| orderDirection | string Default: "ASC" The direction the order will use |
| status | string The status of the state to filter by |
| from | string <date-time> An ISO 8601 datetime to filter results from |
| to | string <date-time> An ISO 8601 datetime to filter results until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "count": 0,
- "developerName": "string",
- "id": "string"
}
]
}Get a listing of all the flow states for a specific flow in the current tenant.
| id required | string <uuid> The ID of the flow |
| pageSize | integer <int32> Default: 10 The number of flow states to return |
| page | integer <int32> Default: 1 The current page of flow states |
| status | string The status of the state to filter by |
| from | string <date-time> An ISO 8601 datetime to filter results from |
| to | string <date-time> An ISO 8601 datetime to filter results until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:30Z",
- "dateModified": "2020-02-18T14:27:30Z",
- "expiresAt": "2020-02-18T14:27:30Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
]
}Get a listing of all the flow states for a specific flow version in the current tenant.
| id required | string <uuid> The ID of the flow |
| version required | string <uuid> The version ID of the flow |
| pageSize | integer <int32> Default: 10 The number of flow states to return |
| page | integer <int32> Default: 1 The current page of flow states |
| status | string The status of the state to filter by |
| from | string <date-time> An ISO 8601 datetime to filter results from |
| to | string <date-time> An ISO 8601 datetime to filter results until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:30Z",
- "dateModified": "2020-02-18T14:27:30Z",
- "expiresAt": "2020-02-18T14:27:30Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:30Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:30Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:30Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
]
}The flow state object provides data about a specific instance of a running flow
A flow state provides in-depth information about how users have interacted with a flow, from the data that has been collected in values, to the path of map elements that were travelled, to the users who have interacted with the flow at the various stages of its execution. Flow state data is only available for active flows that have not yet completed.
This API should also not be used for reporting purposes as we have a separate reporting API and reporting infrastructure.
Get a listing of all the flow states in the current tenant.
| pageSize | integer <int32> Default: 10 The number of states to return |
| page | integer <int32> Default: 1 The current page of states |
| status | string The status of the states to filter by |
| from | string <date-time> An ISO 8601 datetime to filter states from |
| to | string <date-time> An ISO 8601 datetime to filter states until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "expiresAt": "2020-02-18T14:27:31Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
]
}Delete multiple flow states
An array of IDs of the states to delete
Success
[- "string"
]Load an individual flow state
| id required | string <uuid> The ID of the state to load |
Success
{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "expiresAt": "2020-02-18T14:27:31Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}Get a listing of all the flow states grouped by flow in the current tenant.
| pageSize | integer <int32> Default: 10 The number of flow states to return |
| page | integer <int32> Default: 1 The current page of flow states |
| orderBy | string Default: "developerName" The column to order the results by |
| orderDirection | string Default: "ASC" The direction the order will use |
| status | string The status of the state to filter by |
| from | string <date-time> An ISO 8601 datetime to filter results from |
| to | string <date-time> An ISO 8601 datetime to filter results until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "count": 0,
- "developerName": "string",
- "id": "string"
}
]
}Get a listing of all the flow states for a specific flow in the current tenant.
| id required | string <uuid> The ID of the flow |
| pageSize | integer <int32> Default: 10 The number of flow states to return |
| page | integer <int32> Default: 1 The current page of flow states |
| status | string The status of the state to filter by |
| from | string <date-time> An ISO 8601 datetime to filter results from |
| to | string <date-time> An ISO 8601 datetime to filter results until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "expiresAt": "2020-02-18T14:27:31Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
]
}Get a listing of all the flow states for a specific flow version in the current tenant.
| id required | string <uuid> The ID of the flow |
| version required | string <uuid> The version ID of the flow |
| pageSize | integer <int32> Default: 10 The number of flow states to return |
| page | integer <int32> Default: 1 The current page of flow states |
| status | string The status of the state to filter by |
| from | string <date-time> An ISO 8601 datetime to filter results from |
| to | string <date-time> An ISO 8601 datetime to filter results until |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationHeader": "string",
- "currentFlowDeveloperName": "string",
- "currentFlowId": {
- "id": "string",
- "versionId": "string"
}, - "currentMapElementDeveloperName": "string",
- "currentMapElementId": "string",
- "currentRunningUserEmail": "string",
- "currentRunningUserExternalId": "string",
- "currentRunningUserId": "string",
- "currentStreamId": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "expiresAt": "2020-02-18T14:27:31Z",
- "externalIdentifier": "string",
- "frames": [
- {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "runningUserId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "hasRootFaults": true,
- "id": "string",
- "isDone": true,
- "isExpired": true,
- "joinUri": "string",
- "log": {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "manywhoTenantId": "string",
- "parentId": "string",
- "precommitStateEntry": {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "stateEntries": [
- {
- "authenticatingServiceElementId": "string",
- "dateCommitted": "2020-02-18T14:27:31Z",
- "flowDeveloperName": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "id": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string",
- "nextMapElementId": "string",
- "userInteractions": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "userVotes": {
- "property1": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "property2": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
}, - "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
], - "storeId": "string",
- "values": [
- {
- "contentType": "string",
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "valueElementDeveloperName": "string",
- "valueElementId": "string"
}
]
}
]
}Stores define the location and credentials used to store data from the platform externally
A store is an outside location that implements the External Storage API, used by the platform to store data externally. They are intended as a data residency and compliance solution, for any customers that require greater control about the eventual resting place of their platform data.
Currently, the External Storage API only supports storing states externally.
[- {
- "createdAt": "2020-02-18T14:27:31Z",
- "endpoint": "string",
- "id": "string",
- "name": "string",
- "platformKey": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}
]Creates a new store, generating an ID, a keypair for encrypting incoming API requests and a keypair for ensuring payload integrity.
Details to use when creating the store
| authentication | object (StoreAuthentication) |
| endpoint | string The endpoint the store is hosted at, which must support HTTPS. |
| name | string A descriptive name of the store |
Success
{- "authentication": {
- "basicPassword": "string",
- "basicUsername": "string"
}, - "endpoint": "string",
- "name": "string"
}{- "endpoint": "string",
- "id": "string",
- "name": "string",
- "platformKey": "string",
- "receiverKey": "string"
}Finds a store by ID, in the current tenant.
| id required | string <uuid> The ID of the store to find |
Success
{- "createdAt": "2020-02-18T14:27:31Z",
- "endpoint": "string",
- "id": "string",
- "name": "string",
- "platformKey": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}Updates a store by ID, in the current tenant.
| id required | string <uuid> The ID of the store to update |
The properties of the store to update
| authentication | object (StoreAuthentication) |
| endpoint | string The endpoint the store is hosted at, which must support HTTPS. |
| name | string A descriptive name of the store |
Success
{- "authentication": {
- "basicPassword": "string",
- "basicUsername": "string"
}, - "endpoint": "string",
- "name": "string"
}{- "createdAt": "2020-02-18T14:27:31Z",
- "endpoint": "string",
- "id": "string",
- "name": "string",
- "platformKey": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}[- {
- "endedAt": "2020-02-18T14:27:31Z",
- "errorCause": "string",
- "id": "string",
- "startedAt": "2020-02-18T14:27:31Z",
- "status": "string",
- "storeId": "string",
- "updatedAt": "2020-02-18T14:27:31Z",
- "userId": "string"
}
]Starts a migration of data from the current tenant into the selected store.
The properties of the migration
| batchSize | integer <int32> A size of batch that will be used to save states during migration |
| storeId | string <uuid> The id of the store where data will be migrated to |
Success
{- "batchSize": 0,
- "storeId": "string"
}A tenant provides a central place for flow builders to build, manage and deploy flows.
Once a tenant has been provisioned, there are various settings available to ensure security is correctly configured and data is properly managed for reporting purposes. The APIs below work for both tenants and subtenants. The only difference between a tenant and and subtenant is that flow builders can move between them using and the tenants are grouped together to ease management.
Used to get the tenant object for the current tenant. Tenants provide a central place for flow builders to build, manage and deploy flows.
| includeSubTenants | boolean Default: false Whether to include subtenants in the response |
Success
{- "developerName": "string",
- "developerSummary": "string",
- "externalStorageSettings": {
- "enableReplication": true,
- "enableStates": true,
- "globalStoreId": "string"
}, - "id": "string",
- "restrictions": {
- "flowRestrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}
}, - "securitySettings": {
- "authorizedAdminIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedDrawIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedPackagingIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedRunIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "isAdminRestrictedByIPRange": true,
- "isDrawRestrictedByIPRange": true,
- "isPackagingRestrictedByIPRange": true,
- "isRunRestrictedByIPRange": true,
- "isSamlEnabled": true,
- "samlSettings": {
- "certificate": "string",
- "redirectUri": "string"
}
}, - "stateSettings": {
- "endpoint": "string"
}, - "subdomain": "string",
- "subTenants": [
- { }
], - "tenantSettings": {
- "disableServiceInvokerLogging": true,
- "formatValues": true,
- "releaseCycle": "rolling"
}
}Used to update the tenant object for the current tenant. Tenants provide a central place for flow builders to build, manage and deploy flows.
| developerSummary | string A summary of the tenant. This is typically additional information that will help explain the purpose of the tenant |
| externalStorageSettings | object (ExternalStorageSettingsAPI) |
| restrictions | object (TenantRestrictionsAPI) |
| securitySettings | object (SecuritySettingsAPI) Specific security settings that should be applied to this tenant, beyond the defaults (excluding subtenants) |
| stateSettings | object (StateSettingsAPI) Settings used for state persistence and reporting |
| subdomain | string The requested subdomain to register for this tenant. If provided, the subdomain must be unique for the entire platform |
| tenantSettings | object (TenantSettingsAPI) Settings that are specific to features used in the tenant |
Success
{- "developerSummary": "string",
- "externalStorageSettings": {
- "enableReplication": true,
- "enableStates": true,
- "globalStoreId": "string"
}, - "restrictions": {
- "flowRestrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}
}, - "securitySettings": {
- "authorizedAdminIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedDrawIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedPackagingIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedRunIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "isAdminRestrictedByIPRange": true,
- "isDrawRestrictedByIPRange": true,
- "isPackagingRestrictedByIPRange": true,
- "isRunRestrictedByIPRange": true,
- "isSamlEnabled": true,
- "samlSettings": {
- "certificate": "string",
- "redirectUri": "string"
}
}, - "stateSettings": {
- "endpoint": "string"
}, - "subdomain": "string",
- "tenantSettings": {
- "disableServiceInvokerLogging": true,
- "formatValues": true,
- "releaseCycle": "rolling"
}
}{- "developerName": "string",
- "developerSummary": "string",
- "externalStorageSettings": {
- "enableReplication": true,
- "enableStates": true,
- "globalStoreId": "string"
}, - "id": "string",
- "restrictions": {
- "flowRestrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}
}, - "securitySettings": {
- "authorizedAdminIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedDrawIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedPackagingIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedRunIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "isAdminRestrictedByIPRange": true,
- "isDrawRestrictedByIPRange": true,
- "isPackagingRestrictedByIPRange": true,
- "isRunRestrictedByIPRange": true,
- "isSamlEnabled": true,
- "samlSettings": {
- "certificate": "string",
- "redirectUri": "string"
}
}, - "stateSettings": {
- "endpoint": "string"
}, - "subdomain": "string",
- "subTenants": [
- { }
], - "tenantSettings": {
- "disableServiceInvokerLogging": true,
- "formatValues": true,
- "releaseCycle": "rolling"
}
}| cultures | boolean Indicates if all non-default cultures should be deleted |
| flows | boolean Indicates if all flows should be deleted |
| macros | boolean Indicates if all macro elements should be deleted |
| pages | boolean Indicates if all page elements should be deleted |
| services | boolean Indicates if all service elements should be deleted |
| snapshots | boolean Indicates if all flow snapshots should be deleted |
| states | boolean Indicates if all flow states should be deleted |
| tags | boolean Indicates if all tag elements should be deleted |
| types | boolean Indicates if all type elements should be deleted |
| values | boolean Indicates if all value elements should be deleted |
Success
{- "cultures": true,
- "flows": true,
- "macros": true,
- "pages": true,
- "services": true,
- "snapshots": true,
- "states": true,
- "tags": true,
- "types": true,
- "values": true
}[- {
- "developerName": "string",
- "developerSummary": "string",
- "externalStorageSettings": {
- "enableReplication": true,
- "enableStates": true,
- "globalStoreId": "string"
}, - "id": "string",
- "restrictions": {
- "flowRestrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}
}, - "securitySettings": {
- "authorizedAdminIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedDrawIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedPackagingIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "authorizedRunIPRanges": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "endIPAddress": "string",
- "startIPAddress": "string"
}
], - "isAdminRestrictedByIPRange": true,
- "isDrawRestrictedByIPRange": true,
- "isPackagingRestrictedByIPRange": true,
- "isRunRestrictedByIPRange": true,
- "isSamlEnabled": true,
- "samlSettings": {
- "certificate": "string",
- "redirectUri": "string"
}
}, - "stateSettings": {
- "endpoint": "string"
}, - "subdomain": "string",
- "subTenants": [
- { }
], - "tenantSettings": {
- "disableServiceInvokerLogging": true,
- "formatValues": true,
- "releaseCycle": "rolling"
}
}
]Used to create a new subtenant underneath the current tenant. The developerName must be unique,
and can only contain letters and numbers, with no spaces.
| developerName | string |
| developerSummary | string |
Success
{- "developerName": "string",
- "developerSummary": "string"
}{- "developerName": "string",
- "id": "string"
}Users provide basic information about flow builders and running users in a tenant
Users on the platform are identified via their email. As a result, the email address determines who the user is. The email address is the unique identifier across the entire platform. When running users access a flow, a user is provisioned into the tenant on-demand. In addition, flow builders are included in the user listing.
Get a listing of all users inside the current tenant.
| pageSize | integer <int32> Default: 30 |
| page | integer <int32> Default: 1 |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "createdAt": "2020-02-18T14:27:31Z",
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string",
- "password": "string",
- "role": "string",
- "tenants": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "expiresAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isExpired": true,
- "lastLoggedInAt": "2020-02-18T14:27:31Z",
- "settings": {
- "notifications": {
- "enableEmails": true
}
}
}
], - "tokens": [
- {
- "createdAt": "2020-02-18T14:27:31Z",
- "serviceId": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}
], - "verified": true
}
]
}| createdAt | string <date-time> |
string | |
| firstName | string |
| id | string <uuid> |
| lastName | string |
| password | string |
| role | string |
| tenants | Array of objects (UserTenantAPI) |
| tokens | Array of objects (UserTokenAPI) |
| verified | boolean |
Success
{- "createdAt": "2020-02-18T14:27:31Z",
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string",
- "password": "string",
- "role": "string",
- "tenants": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "expiresAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isExpired": true,
- "lastLoggedInAt": "2020-02-18T14:27:31Z",
- "settings": {
- "notifications": {
- "enableEmails": true
}
}
}
], - "tokens": [
- {
- "createdAt": "2020-02-18T14:27:31Z",
- "serviceId": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}
], - "verified": true
}{- "createdAt": "2020-02-18T14:27:31Z",
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string",
- "password": "string",
- "role": "string",
- "tenants": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "expiresAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isExpired": true,
- "lastLoggedInAt": "2020-02-18T14:27:31Z",
- "settings": {
- "notifications": {
- "enableEmails": true
}
}
}
], - "tokens": [
- {
- "createdAt": "2020-02-18T14:27:31Z",
- "serviceId": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}
], - "verified": true
}Load an individual user from the current tenant.
| id required | string <uuid> |
Success
{- "createdAt": "2020-02-18T14:27:31Z",
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string",
- "password": "string",
- "role": "string",
- "tenants": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "expiresAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isExpired": true,
- "lastLoggedInAt": "2020-02-18T14:27:31Z",
- "settings": {
- "notifications": {
- "enableEmails": true
}
}
}
], - "tokens": [
- {
- "createdAt": "2020-02-18T14:27:31Z",
- "serviceId": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}
], - "verified": true
}Update information for an individual user in the current tenant.
| id required | string <uuid> |
| createdAt | string <date-time> |
string | |
| firstName | string |
| id | string <uuid> |
| lastName | string |
| password | string |
| role | string |
| tenants | Array of objects (UserTenantAPI) |
| tokens | Array of objects (UserTokenAPI) |
| verified | boolean |
Success
{- "createdAt": "2020-02-18T14:27:31Z",
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string",
- "password": "string",
- "role": "string",
- "tenants": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "expiresAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isExpired": true,
- "lastLoggedInAt": "2020-02-18T14:27:31Z",
- "settings": {
- "notifications": {
- "enableEmails": true
}
}
}
], - "tokens": [
- {
- "createdAt": "2020-02-18T14:27:31Z",
- "serviceId": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}
], - "verified": true
}{- "createdAt": "2020-02-18T14:27:31Z",
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string",
- "password": "string",
- "role": "string",
- "tenants": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "expiresAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isExpired": true,
- "lastLoggedInAt": "2020-02-18T14:27:31Z",
- "settings": {
- "notifications": {
- "enableEmails": true
}
}
}
], - "tokens": [
- {
- "createdAt": "2020-02-18T14:27:31Z",
- "serviceId": "string",
- "updatedAt": "2020-02-18T14:27:31Z"
}
], - "verified": true
}{- "createdAt": "2020-02-18T14:27:31Z",
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string",
- "password": "string",
- "tenants": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "expiresAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isExpired": true,
- "lastLoggedInAt": "2020-02-18T14:27:31Z",
- "settings": {
- "notifications": {
- "enableEmails": true
}
}
}
], - "verified": true
}Load the settings for the currently-authenticated user
Success
{- "notifications": {
- "enableEmails": true
}
}Update the settings for the currently-authenticated user
| notifications | object (UserTenantSettingsNotificationsAPI) |
Success
{- "notifications": {
- "enableEmails": true
}
}{- "notifications": {
- "enableEmails": true
}
}[- {
- "contentType": "string",
- "key": "string",
- "modifiedAt": "2020-02-18T14:27:31Z",
- "name": "string",
- "publicUrl": "string",
- "size": 0
}
]Move an asset from one location to another (can also be used to rename an asset).
| newKey | string The key to move the asset to |
| oldKey | string The key of the asset to move |
Success
{- "newKey": "string",
- "oldKey": "string"
}Create an empty "folder" in the current tenant's asset storage
| contentType | string |
| key | string |
| modifiedAt | string <date-time> |
| name | string |
| publicUrl | string |
| size | integer <int64> |
Success
{- "contentType": "string",
- "key": "string",
- "modifiedAt": "2020-02-18T14:27:31Z",
- "name": "string",
- "publicUrl": "string",
- "size": 0
}Delete an individual asset (or folder)
| contentType | string |
| key | string |
| modifiedAt | string <date-time> |
| name | string |
| publicUrl | string |
| size | integer <int64> |
Success
{- "contentType": "string",
- "key": "string",
- "modifiedAt": "2020-02-18T14:27:31Z",
- "name": "string",
- "publicUrl": "string",
- "size": 0
}Generate a signed upload URL, which should be used to submit the asset to (using PUT). A contentType is
required in this request.
| contentType | string |
| key | string |
| modifiedAt | string <date-time> |
| name | string |
| publicUrl | string |
| size | integer <int64> |
Success
{- "contentType": "string",
- "key": "string",
- "modifiedAt": "2020-02-18T14:27:31Z",
- "name": "string",
- "publicUrl": "string",
- "size": 0
}"string"Authenticate flow builders before using the Admin, Draw, Packaging and Translate APIs
Once a tenant and flow builder have been provisioned, you can authenticate using the Draw API. The returned
token should be used in the standard HTTP Authorization header when performing any operations against the
various supported APIs.
| password | string The password for your account in the directory |
| username | string The username for your account in the directory |
Success
{- "password": "string",
- "username": "string"
}"string"| tenant required | string <uuid> The ID of the tenant to authenticate into |
Success
"string"List the flattened tree of elements that depends on a specific element.
| id required | string <uuid> The ID of the element to list dependents of |
| pageSize | integer <int32> Default: 50 The number of dependents to return per page |
| page | integer <int32> Default: 1 The current page number of dependents |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "dependsOnElementDeveloperName": "string",
- "dependsOnElementDeveloperSummary": "string",
- "dependsOnElementId": "string",
- "dependsOnElementType": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "type": "string"
}
]
}List the flattened tree of elements that a specific element depends on, including all registered dependencies of dependencies.
| id required | string <uuid> The ID of the element to list dependencies of |
| pageSize | integer <int32> Default: 50 The number of dependencies to return per page |
| page | integer <int32> Default: 1 The current page number of dependencies |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "dependsOnElementDeveloperName": "string",
- "dependsOnElementDeveloperSummary": "string",
- "dependsOnElementId": "string",
- "dependsOnElementType": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "type": "string"
}
]
}Flows represent an entire application
Flows represent an atomic package of elements that when run, are fully versioned. Flows can reference other flows using a "flow out" or by messaging other flows in the tenant using the Runtime Service. When referencing flows (parent or subflows), the platform will always take the latest activated and default version of the flow.
When editing elements in a flow, you do not do this through this section of the APIs. Each element type has its own API endpoint for managing objects, etc.
As with group elements, a flow can also have permissions. However, unlike the group element, if a user cannot authenticate to a flow, they cannot access any part of the flow state. Effectively, the flow authorization protects your flow application from any access by running users that cannot successfully authenticate with the provided authorization criteria. Therefore any group elements act as a subset of authorization. The running users must first authenticate successfully into the flow and subsequently authenticate into any group elements. Further to this, there's no requirement that the flow and group elements use the same service for authentication. Flow builders can build flows that authenticate across multiple systems, move from unauthenticated to authenticated access, etc.
Used to list and filter existing flows.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of flows where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of flows where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter for querying flows |
Success
[- {
- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create new flows or update existing ones. The flow object represents an entire flow application.
| allowJumping | boolean Indicates that the builder of the flow will allow users to jump to any position in the Flow regardless of outcomes and/or navigation. |
| authorization | object (GroupAuthorizationAPI) |
| developerName | string The developer name for the flow. When referencing flows by name, this is the name you should use in your referencing. |
| developerSummary | string The developer summary the author provided to give more information about the Flow. |
| editingToken | string <uuid> A unique token for this particular editing session |
| id | object (FlowIdAPI) A composite unique identifier assigned by the platform, which should not be included for new flows. |
| restrictions | object (FlowRestrictionsAPI) |
| startMapElementId | string The unique identifier for the first element in the flow. This element is always of the |
| stateExpirationLength | integer <int32> |
Success
{- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0
}{- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get an existing flow by ID.
| id required | string <uuid> The unique identifier for the Flow |
Success
{- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to list all the elements of a type used in a flow
| flow required | string <uuid> The unique identifier for the flow |
| elementType required | string The element type to list |
Success
[- {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to import an existing element into a flow
| flow required | string <uuid> The unique identifier for the flow |
| elementType required | string The element type to import |
| id required | string <uuid> The ID of the element to import |
Success
Used to remove an imported element from a flow
| flow required | string <uuid> The unique identifier for the flow |
| elementType required | string The element type to remove |
| id required | string <uuid> The ID of the element to remove |
Success
The Flow Graph object provides the coordinate and basic configuration information of map and group elements.
The Flow Graph object is typically used for editing the layout of the flow for flow builders. This API should not be used for creating new flows, but rather to manage map and group elements in an existing flow. The focus of this API is to allow flow builders to make coordinate changes to these elements while ensuring other flow builders are notified of these changes and can be updated in realtime.
Used to update a flow graph.
| allowJumping | boolean Indicates that the builder of the flow will allow users to jump to any position in the Flow regardless of outcomes and/or navigation. |
| authorization | object (GroupAuthorizationAPI) |
| developerName | string The developer name for the flow. When referencing flows by name, this is the name you should use in your referencing. |
| developerSummary | string The developer summary the author provided to give more information about the Flow. |
| editingToken | string <uuid> A unique token for this particular editing session |
| groupElements | Array of objects (GroupElementAPI) An array of group elements that are part of the flow graph. |
| id | object (FlowIdAPI) A composite unique identifier assigned by the platform, which should not be included for new flows. |
| mapElements | Array of objects (MapElementAPI) An array of map elements that are part of the flow graph. |
| restrictions | object (FlowRestrictionsAPI) |
| startMapElementId | string The unique identifier for the first element in the flow. This element is always of the |
| stateExpirationLength | integer <int32> |
Success
{- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "groupElements": [
- {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}
], - "id": {
- "id": "string",
- "versionId": "string"
}, - "mapElements": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}
], - "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0
}{- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "groupElements": [
- {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}
], - "id": {
- "id": "string",
- "versionId": "string"
}, - "mapElements": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}
], - "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "tenantId": "string"
}Used to get an existing flow graph. The flow graph provides the coordinate and basic configuration information of map and group elements.
| flow required | string The unique identifier for the flow |
Success
{- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "groupElements": [
- {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}
], - "id": {
- "id": "string",
- "versionId": "string"
}, - "mapElements": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}
], - "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "tenantId": "string"
}The flow snapshot is the package that is sent to the platform runtime engine.
Without a flow snapshot, a flow cannot be accessed by running users. The flow snapshot contains all the fully versioned elements that are needed for the flow to execute (excluding subflows). In the tooling, each time a flow is run or published, a flow snapshot is taken. This means you then have a version of the flow that can also be reverted if flow builders make a range of mistakes and would like to go back to a previous snapshot.
The flow snapshot also acts as a version system as all metadata for the flow can be accessed, and external tools can be used to diff for changes. Equally, for compliance, a customer can access the flow snapshots to get a complete picture of which flow the running user(s) were running at any particular point in time.
Used to activate and/or make default a flow snapshot version
| flow required | string The unique identifier for the flow |
| version required | string The unique identifier for the flow version |
| isDefault required | boolean If this snapshot should be the default version for running users |
| isActivated required | boolean If this snapshot should be accessible to running users to run |
Success
{- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to take an flow snapshot and apply it to the current flow being modelled. This is equivalent to undoing changes to a flow for all flow builders.
To revert a flow snapshot for running users, simply activate and make default the appropriate previous flow snapshot version.
| flow required | string The unique identifier for the flow |
| version required | string The unique identifier for the flow version |
Success
Used to get the list of all snapshots for a particular flow.
| flow required | string <uuid> |
| filter | string |
Success
[- {
- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create a flow snapshot.
| flow required | string The unique identifier for the flow |
Success
"string"{- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get a single flow snapshot.
| flow required | string The unique identifier for the flow |
| version required | string The unique identifier for the flow version |
Success
{- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "groupElements": [
- {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}
], - "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "macroElements": [
- {
- "code": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "mapElements": [
- {
- "clearNavigationOverrides": true,
- "dataActions": [
- {
- "crudOperationType": "string",
- "developerName": "string",
- "disabled": true,
- "isSmartSave": true,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "listeners": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "listenerType": "string",
- "serviceElementId": "string",
- "valueElementToReferenceForListeningId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "messageActions": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}
], - "navigationOverrides": [
- {
- "isEnabled": true,
- "isVisible": true,
- "locationMapElementDeveloperName": "string",
- "locationMapElementId": "string",
- "navigationElementDeveloperName": "string",
- "navigationElementId": "string",
- "navigationItemDeveloperName": "string",
- "navigationItemId": "string"
}
], - "notAuthorizedMessage": "string",
- "operations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "postUpdateMessage": "string",
- "postUpdateToStream": true,
- "postUpdateWhenType": "string",
- "statusMessage": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "updateByName": true,
- "userContent": "string",
- "viewMessageAction": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}, - "vote": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "minimumCount": 0,
- "minimumPercent": 0,
- "voteType": "string"
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}
], - "navigationElements": [
- {
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "label": "string",
- "navigationItems": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "label": "string",
- "locationMapElementId": "string",
- "navigationItems": [
- { }
], - "order": 0,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "valuesToReset": [
- {
- "id": "string",
- "resetType": "string"
}
]
}
], - "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "pageElements": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "label": "string",
- "pageComponents": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "boundTypeElementPropertyId": "string",
- "componentType": "string",
- "isBound": true,
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "content": "string",
- "developerName": "string",
- "fileDataRequest": {
- "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string"
}, - "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "imageUri": "string",
- "isEditable": true,
- "isMultiSelect": true,
- "isRequired": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "valueElementDataBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementValueBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "width": 0
}
], - "pageConditions": [
- {
- "comparisonType": "string",
- "generatedSummary": "string",
- "pageOperations": [
- {
- "assignment": {
- "assignee": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "assignor": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}, - "filter": {
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "filterValue": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "pageComponentDeveloperName": "string",
- "pageComponentId": "string"
}, - "generatedSummary": "string"
}
], - "pageRules": [
- {
- "criteriaType": "string",
- "generatedSummary": "string",
- "left": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "right": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}
]
}
], - "pageContainers": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainers": [
- { }
], - "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "stopConditionsOnFirstTrue": true,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "serviceElements": [
- {
- "actions": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "isViewMessageAction": true,
- "serviceActionOutcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "id": "string"
}
], - "serviceInputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceOutputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "uriPart": "string"
}
], - "configurationValues": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "format": "string",
- "httpAuthenticationPassword": "string",
- "httpAuthenticationUsername": "string",
- "id": "string",
- "install": {
- "typeElements": [
- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]
}, - "providesAutoBinding": true,
- "providesDatabase": true,
- "providesFiles": true,
- "providesIdentity": true,
- "providesLocation": true,
- "providesLogic": true,
- "providesSocial": true,
- "providesViews": true,
- "sendDecryptedValues": true,
- "updateByName": true,
- "uri": "string",
- "version": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "tagElements": [
- {
- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "typeElements": [
- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "valueElements": [
- {
- "access": "string",
- "contentFormat": "string",
- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "defaultContentValue": "string",
- "defaultObjectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "initializationOperations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "isFixed": true,
- "isVersionless": true,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}The group element object represents any group or element in your flow that can contain map elements.
Group elements are used to add additional behavior to map elements in your flow. The group element currently only supports the ability to change the authentication context of the map elements it contains. This allows builders to change the permissions for map elements contained in the group element and restrict the ability for running users to edit or take action on any outcomes.
Used to list and filter existing group elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> The unique identifier for the flow containing the group element |
| filter | string The filter used for querying |
Success
[- {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}
]Used to create new group elements or update existing ones.
| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> Unique identifier for the flow containing the group element |
| authorization | object (GroupAuthorizationAPI) |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| groupElementId | string The unique identifier for the group element that holds this group element. |
| height | integer <int32> The height of the Group on the Flow diagram. |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| updateByName | boolean Indicates if the platform should attempt to find a group with the same developer name as the one provided and match them up by name as opposed to by ID. |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
| width | integer <int32> The width of the Group on the Flow diagram. |
| x | integer <int32> The x location of the Group on the Flow diagram. |
| y | integer <int32> The y location of the Group on the Flow diagram. |
Success
{- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}{- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}Used to get an existing group element.
| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> The unique identifier for the flow containing the group element |
| id required | string <uuid> The unique identifier for the group element |
Success
{- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "height": 0,
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "width": 0,
- "x": 0,
- "y": 0
}Used to delete an existing group element.
| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> The unique identifier for the flow containing the group element |
| id required | string <uuid> The unique identifier for the group element |
Success
Used to list and filter existing macro elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
Success
[- {
- "code": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create new macro elements or update existing ones.
| code | string The JavaScript code for the Macro. |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| updateByName | boolean Indicates if the platform should attempt to find a Macro with the same developer name as the one provided and match them up by name as opposed to 'id'. This is useful when creating scripts to create Flows - as you can use the developerName property as the reference as opposed to needing to know the ids of all created Elements. |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
Success
{- "code": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}{- "code": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get an existing macro element.
| id required | string <uuid> The unique identifier for the macro element |
Success
{- "code": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}The map element object represents any node or element in your flow diagram.
Map elements are used to set out the actions and journey of your flow. Each map element performs an action, which may be to present the user with information, collect information, or perform logical actions such as inserting records into a database, executing business rules, or sending messages to a 3rd party application.
There's a lot of functionality packed into map elements, and that has been separated out in the sections below.
A data action is used to perform create, read, update, or delete (CRUD) type operations on a service. There are a number of features that make data actions particularly powerful:
INSERT vs. UPDATE operations. We automatically track the
objects in your flow and know if it is a new object to be inserted or an update to an existing object. This is
done using our SAVE operation. We do not separate INSERT and UPDATE.A Listener is used to listen to events on objects stored or managed by a service. When an event occurs (e.g. a record is updated) in the underlying application (e.g. Salesforce), the platform will inform the executing flow of the event so it can take appropriate action.
Listeners work as follows:
A Message Action is used to perform general API operations on a Service. There are a number of features that make Message Actions particularly powerful:
It's important to note that message actions are described in the service definition. The purpose of the message actions is to map values in the flow to the inputs and outputs specified by the service.
A navigation override is used to alter the functionality of navigation in your flow. As running users go through a flow, it is often useful to alter how the navigation works. As a result, when the user gets to a particular map element, you can execute changes to the navigation. These changes will persist until altered by another map element. This can be useful in a variety of use-cases:
An operation is used to make a change to a value or execute a macro in your flow. Each operation can be ordered allowing builders to do operations in a particular sequence - as individual commands performed on values. Here are some examples of operations:
In mathematics, an operation would be something like: x = 3
An outcome is used to make move the running user(s) from one map element in the flow to another or from one map element into another flow. An outcome can represent a button the running user(s) can click, or it can represent a path the executing flow should follow based on logical operations in the flow. Outcomes can be combined with business rules (provided by comparison/rules) to determine the path of execution based on pre-determined logic.
The vote object is used to configure voting or multi-user approval options on an outcome. By configuring the vote, you can determine if a set number of running users or a percentage of running users (within the authentication context of the map element) must click on a particular outcome before the flow will proceed down that path. For example, before the approval is accepted, more than two running users must click on the “Approve” outcome before the flow will progress.
The implementation of the vote algorithm is determined by the service. Builders should refer to the documentation of the service being used. The first running user to click on an outcome contained in a voting map element will force the platform to “lock” the page from any further user inputs. Effectively the map element becomes read-only until the vote is completed.
Used to filter existing map elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> The unique identifier for the flow containing the map elements |
| filter | string The filter used for querying |
Success
[- {
- "clearNavigationOverrides": true,
- "dataActions": [
- {
- "crudOperationType": "string",
- "developerName": "string",
- "disabled": true,
- "isSmartSave": true,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "listeners": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "listenerType": "string",
- "serviceElementId": "string",
- "valueElementToReferenceForListeningId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "messageActions": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}
], - "navigationOverrides": [
- {
- "isEnabled": true,
- "isVisible": true,
- "locationMapElementDeveloperName": "string",
- "locationMapElementId": "string",
- "navigationElementDeveloperName": "string",
- "navigationElementId": "string",
- "navigationItemDeveloperName": "string",
- "navigationItemId": "string"
}
], - "notAuthorizedMessage": "string",
- "operations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "postUpdateMessage": "string",
- "postUpdateToStream": true,
- "postUpdateWhenType": "string",
- "statusMessage": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "updateByName": true,
- "userContent": "string",
- "viewMessageAction": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}, - "vote": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "minimumCount": 0,
- "minimumPercent": 0,
- "voteType": "string"
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}
]Used to create new map elements or update existing ones.
| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> The unique identifier for the flow containing the map element |
| clearNavigationOverrides | boolean |
| dataActions | Array of objects (DataActionAPI) The list of data actions that should be executed when this map element executes. The data action objects define the values and bindings that should be used to perform CRUD operations against each service and value. |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| groupElementId | string The unique identifier for the Group that contains this Map Element. If a Map Element is inside a Group, it inherits certain behaviors of the parent Group. For example, a Swimlane Group wraps all child Map Elements in a security context. |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| listeners | Array of objects (ListenerAPI) The list of listeners that should be registered when this Map Element executes. |
| messageActions | Array of objects (MessageActionAPI) The list of message actions that should be executed when this Map Element executes. The message action objects define the interface of inputs/outputs for calling against each Service message. |
| navigationOverrides | Array of objects (NavigationOverrideAPI) The list of navigation overrides that should be applied when this Map Element executes. |
| notAuthorizedMessage | string The content that should be shown to the user if they are not authorized to take action on this Map Element. |
| operations | Array of objects (OperationAPI) The list of operations that should be performed when this Map Element executes. Operations are used to change the value of Values in the executing Flow (State). |
| outcomes | Array of objects (OutcomeAPI) The list of outcomes that are available for this Map Element. An Outcome is used to connect the flow of execution from one Map Element in the Flow to another. An Outcome can take the form of a Page button, but also define system steps such as rules. |
| pageElementId | string |
| postUpdateMessage | string The content of the message that should be posted to the collaboration stream. |
| postUpdateToStream | boolean Indicates if this Map Element should post an update to the collaboration stream. |
| postUpdateWhenType | string The point at which the post should be made to the collaboration stream. |
| statusMessage | string The content that should be shown to the user while waiting for a system step to complete. |
| subflow | object (SubflowAPI) |
| updateByName | boolean Indicates if the platform should attempt to find a Type with the same developer name as the one provided and match them up by name as opposed to 'id'. This is useful when creating scripts to create Flows - as you can use the developerName property as the reference as opposed to needing to know the ids of all created Elements. |
| userContent | string The content that should be shown to the user at this step in the Flow. This property should only be used for very simple Flows and informational UI. For anything more than simple messaging, use the Page and associate it with this Map Element using the pageElementId property. |
| viewMessageAction | object (MessageActionAPI) |
| vote | object (VoteAPI) |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
| x | integer <int32> The x location of the Map Element on the Flow diagram. |
| y | integer <int32> The y location of the Map Element on the Flow diagram. |
Success
{- "clearNavigationOverrides": true,
- "dataActions": [
- {
- "crudOperationType": "string",
- "developerName": "string",
- "disabled": true,
- "isSmartSave": true,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "listeners": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "listenerType": "string",
- "serviceElementId": "string",
- "valueElementToReferenceForListeningId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "messageActions": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}
], - "navigationOverrides": [
- {
- "isEnabled": true,
- "isVisible": true,
- "locationMapElementDeveloperName": "string",
- "locationMapElementId": "string",
- "navigationElementDeveloperName": "string",
- "navigationElementId": "string",
- "navigationItemDeveloperName": "string",
- "navigationItemId": "string"
}
], - "notAuthorizedMessage": "string",
- "operations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "postUpdateMessage": "string",
- "postUpdateToStream": true,
- "postUpdateWhenType": "string",
- "statusMessage": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "updateByName": true,
- "userContent": "string",
- "viewMessageAction": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}, - "vote": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "minimumCount": 0,
- "minimumPercent": 0,
- "voteType": "string"
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}{- "clearNavigationOverrides": true,
- "dataActions": [
- {
- "crudOperationType": "string",
- "developerName": "string",
- "disabled": true,
- "isSmartSave": true,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "listeners": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "listenerType": "string",
- "serviceElementId": "string",
- "valueElementToReferenceForListeningId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "messageActions": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}
], - "navigationOverrides": [
- {
- "isEnabled": true,
- "isVisible": true,
- "locationMapElementDeveloperName": "string",
- "locationMapElementId": "string",
- "navigationElementDeveloperName": "string",
- "navigationElementId": "string",
- "navigationItemDeveloperName": "string",
- "navigationItemId": "string"
}
], - "notAuthorizedMessage": "string",
- "operations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "postUpdateMessage": "string",
- "postUpdateToStream": true,
- "postUpdateWhenType": "string",
- "statusMessage": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "updateByName": true,
- "userContent": "string",
- "viewMessageAction": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}, - "vote": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "minimumCount": 0,
- "minimumPercent": 0,
- "voteType": "string"
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}Used to get an existing map element.
| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> The unique identifier for the flow containing the map element |
| id required | string <uuid> The unique identifier for the map element |
Success
{- "clearNavigationOverrides": true,
- "dataActions": [
- {
- "crudOperationType": "string",
- "developerName": "string",
- "disabled": true,
- "isSmartSave": true,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "groupElementId": "string",
- "id": "string",
- "listeners": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "listenerType": "string",
- "serviceElementId": "string",
- "valueElementToReferenceForListeningId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "messageActions": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}
], - "navigationOverrides": [
- {
- "isEnabled": true,
- "isVisible": true,
- "locationMapElementDeveloperName": "string",
- "locationMapElementId": "string",
- "navigationElementDeveloperName": "string",
- "navigationElementId": "string",
- "navigationItemDeveloperName": "string",
- "navigationItemId": "string"
}
], - "notAuthorizedMessage": "string",
- "operations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "outcomes": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "comparison": {
- "comparisons": [
- { }
], - "comparisonType": "string",
- "order": 0,
- "rules": [
- {
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "leftValueElementToReferenceDeveloperName": "string",
- "leftValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "rightValueElementToReferenceDeveloperName": "string",
- "rightValueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "controlPoints": [
- {
- "x": 0,
- "y": 0
}
], - "developerName": "string",
- "developerSummary": "string",
- "flowOut": {
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "valueElementExternalIdentifierId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementFlowId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementStateId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "id": "string",
- "isBulkAction": true,
- "label": "string",
- "nextMapElementDeveloperName": "string",
- "nextMapElementId": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageElementId": "string",
- "postUpdateMessage": "string",
- "postUpdateToStream": true,
- "postUpdateWhenType": "string",
- "statusMessage": "string",
- "subflow": {
- "arguments": [
- {
- "valueElementInSubflowId": {
- "id": "string"
}, - "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "flowId": {
- "id": "string",
- "versionId": "string"
}
}, - "updateByName": true,
- "userContent": "string",
- "viewMessageAction": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "disabled": true,
- "inputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "order": 0,
- "outputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceDeveloperName": "string"
}
], - "serviceActionName": "string",
- "serviceElementId": "string",
- "uriPart": "string"
}, - "vote": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "minimumCount": 0,
- "minimumPercent": 0,
- "voteType": "string"
}, - "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "x": 0,
- "y": 0
}Used to delete an existing map element.
| editingToken required | string <uuid> The active editing token for the flow being edited |
| flow required | string <uuid> The unique identifier for the flow containing the map element |
| id required | string <uuid> The unique identifier for the map element |
Success
The page element object provides the structure of your pages or screens.
The purpose of the page element is to allow flow builders to lay out the structure of the pages the users will interact with as part of the flow application. The page element is extremely extensible and allows developers to create their own components and containers as needed to give users the best possible experience using your flow application. The base properties of the page element are outlined here.
A page container is used to determine the scaffolding of your page. Page containers allow flow builders to set
out the relative position of page components on the page. In comparison with HTML5, a page container would be
equivalent to a div tag. As a result, page containers do not have any value or input, they are
simply used to determine the layout or scaffolding aspects of the page.
The type of page container is determined by the containerType property and developers looking to
build custom containers should use a unique containerType name to identify their container
implementation. The properties outlined here are the common attributes for typical containers, however, if
these do not suffice, developers should use the attributes to extend the attributes for their own
specific needs. It’s important to note that each of the properties here provides features and the engine does
not have any understanding of one container type from another.
A page component is used to show or edit information on your page. In comparison with HTML5, a page component
would be equivalent to an input, textarea, or similar tag. As a result, page
components typically do have a value or input, and are used to prompt the user for some form or input or to view
a particular piece of information on the page.
The type of page component is determined by the componentType property and developers looking to
build custom components should use a unique componentType name to identify their component
implementation. The properties outlined here are the common attributes for typical components, however, if
these do not suffice, developers should use the attributes to extend the attributes for their own
specific needs. It’s important to note that each of the properties here provides features and the engine does
not have any understanding of one component type from another.
Page conditions are used to make your pages dynamic. Based on a set of page rules, the page conditions can
assign values to your page components but also change various properties on your page components and containers
such as: required, editable, visible. Page components can also have data
refreshed and objectDataRequest information dynamically assigned so you can, for example, change
table filters. This gives flow builders the ability to provide single pages that can provide the running user(s)
with a very dynamic experience.
The assignment object should be used when a value or piece of metadata for a component or container needs to be
changed. For example, a page component should be set as required under a specific set of
conditions. Or a page container should no longer be visible under another set of conditions.
The filter object should be used when applying filters based on conditions. For example, the list of options in
a combobox should be limited based on a checkbox being checked. The filter object can be applied to lists as
well as objectDataRequests.
The page object reference is a general purpose object for referencing data and metadata on the page. It can be configured to reference data that is not formally stored into the flow state and also value elements that are.
Used to list and filter existing page elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
Success
[- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "label": "string",
- "pageComponents": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "boundTypeElementPropertyId": "string",
- "componentType": "string",
- "isBound": true,
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "content": "string",
- "developerName": "string",
- "fileDataRequest": {
- "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string"
}, - "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "imageUri": "string",
- "isEditable": true,
- "isMultiSelect": true,
- "isRequired": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "valueElementDataBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementValueBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "width": 0
}
], - "pageConditions": [
- {
- "comparisonType": "string",
- "generatedSummary": "string",
- "pageOperations": [
- {
- "assignment": {
- "assignee": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "assignor": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}, - "filter": {
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "filterValue": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "pageComponentDeveloperName": "string",
- "pageComponentId": "string"
}, - "generatedSummary": "string"
}
], - "pageRules": [
- {
- "criteriaType": "string",
- "generatedSummary": "string",
- "left": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "right": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}
]
}
], - "pageContainers": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainers": [
- { }
], - "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "stopConditionsOnFirstTrue": true,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create new page elements or update existing ones.
| attributes | object Key value pairs that provide additional information for the page layout to be rendered. Builders should refer to the documentation of the UI code being used. |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| label | string The label for the page element. This is usually used as the title of the page. |
| pageComponents | Array of objects (PageComponentAPI) The list of components to be embedded on the page. Each component is associated with a page container for
relative positioning information. Conceptually, page containers are similar to HTML5 |
| pageConditions | Array of objects (PageConditionAPI) The list of page conditions that set out the rules that should be evaluated and the actions that should be
taken if those rules evaluate to |
| pageContainers | Array of objects (PageContainerAPI) The tree hierarchy of page containers that define the scaffolding of the page layout. Conceptually, page
containers are similar to HTML5 |
| stopConditionsOnFirstTrue | boolean Indicates if the engine should continue to execute rules and actions on the page if a condition evaluates
to |
| tags | Array of objects (PageTagAPI) The list of page tags that allow additional metadata to be applied to various page objects: components, controls and the overall page. Conceptually tags can be used to mimic HTML and CSS but can also be used to provide data to enrich functionality on the page. |
| updateByName | boolean Indicates if the platform should attempt to find a page element with the same developer name as the one
provided and match them up by name as opposed to by ID. This is useful when creating scripts to create
flows, as you can use the |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
Success
{- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "label": "string",
- "pageComponents": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "boundTypeElementPropertyId": "string",
- "componentType": "string",
- "isBound": true,
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "content": "string",
- "developerName": "string",
- "fileDataRequest": {
- "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string"
}, - "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "imageUri": "string",
- "isEditable": true,
- "isMultiSelect": true,
- "isRequired": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "valueElementDataBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementValueBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "width": 0
}
], - "pageConditions": [
- {
- "comparisonType": "string",
- "generatedSummary": "string",
- "pageOperations": [
- {
- "assignment": {
- "assignee": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "assignor": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}, - "filter": {
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "filterValue": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "pageComponentDeveloperName": "string",
- "pageComponentId": "string"
}, - "generatedSummary": "string"
}
], - "pageRules": [
- {
- "criteriaType": "string",
- "generatedSummary": "string",
- "left": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "right": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}
]
}
], - "pageContainers": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainers": [
- { }
], - "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "stopConditionsOnFirstTrue": true,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}{- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "label": "string",
- "pageComponents": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "boundTypeElementPropertyId": "string",
- "componentType": "string",
- "isBound": true,
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "content": "string",
- "developerName": "string",
- "fileDataRequest": {
- "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string"
}, - "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "imageUri": "string",
- "isEditable": true,
- "isMultiSelect": true,
- "isRequired": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "valueElementDataBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementValueBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "width": 0
}
], - "pageConditions": [
- {
- "comparisonType": "string",
- "generatedSummary": "string",
- "pageOperations": [
- {
- "assignment": {
- "assignee": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "assignor": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}, - "filter": {
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "filterValue": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "pageComponentDeveloperName": "string",
- "pageComponentId": "string"
}, - "generatedSummary": "string"
}
], - "pageRules": [
- {
- "criteriaType": "string",
- "generatedSummary": "string",
- "left": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "right": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}
]
}
], - "pageContainers": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainers": [
- { }
], - "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "stopConditionsOnFirstTrue": true,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get an existing page element.
| id required | string <uuid> The unique identifier for the page element |
Success
{- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "label": "string",
- "pageComponents": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "boundTypeElementPropertyId": "string",
- "componentType": "string",
- "isBound": true,
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "content": "string",
- "developerName": "string",
- "fileDataRequest": {
- "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string"
}, - "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "imageUri": "string",
- "isEditable": true,
- "isMultiSelect": true,
- "isRequired": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "valueElementDataBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementValueBindingReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "width": 0
}
], - "pageConditions": [
- {
- "comparisonType": "string",
- "generatedSummary": "string",
- "pageOperations": [
- {
- "assignment": {
- "assignee": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "assignor": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}, - "filter": {
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "filterValue": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "objectDataRequest": {
- "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "filterId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "orderBy": [
- {
- "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string"
}
], - "orderByDirectionType": "string",
- "orderByTypeElementPropertyId": "string",
- "properties": [
- {
- "typeElementPropertyId": "string"
}
], - "searchCriteria": [
- {
- "columnTypeElementPropertyId": "string"
}
], - "where": [
- {
- "columnTypeElementPropertyDeveloperName": "string",
- "columnTypeElementPropertyId": "string",
- "criteriaType": "string",
- "criteriaTypeFriendly": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}, - "typeElementBindingId": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}, - "pageComponentDeveloperName": "string",
- "pageComponentId": "string"
}, - "generatedSummary": "string"
}
], - "pageRules": [
- {
- "criteriaType": "string",
- "generatedSummary": "string",
- "left": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}, - "right": {
- "metadataType": "string",
- "pageObjectReferenceDeveloperName": "string",
- "pageObjectReferenceId": "string",
- "typeElementPropertyId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
}
]
}
], - "pageContainers": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainers": [
- { }
], - "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
]
}
], - "stopConditionsOnFirstTrue": true,
- "tags": [
- {
- "tagElementId": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to obtain a describe response for a service element.
The details required to describe the service element
| configurationValues | Array of objects (EngineValueAPI) Configuration values provided by the end user to help the describe. |
| culture | object (CultureAPI) |
| httpAuthenticationPassword | string |
| httpAuthenticationUsername | string |
| uri | string The Uri for the service to describe. |
| version | string |
Success
{- "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "httpAuthenticationPassword": "string",
- "httpAuthenticationUsername": "string",
- "uri": "string",
- "version": "string"
}{- "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "isRequired": true,
- "order": 0,
- "typeElementDeveloperName": "string"
}
], - "providesAutoBinding": true,
- "providesDatabase": true,
- "providesFiles": true,
- "providesIdentity": true,
- "providesLogic": true,
- "providesSocial": true,
- "providesViews": true
}Used to obtain an install response for a service element.
The details required to install the service element
| configurationValues | Array of objects (EngineValueAPI) Configuration values provided by the end user to help the describe. |
| culture | object (CultureAPI) |
| httpAuthenticationPassword | string |
| httpAuthenticationUsername | string |
| uri | string The Uri for the service to describe. |
| version | string |
Success
{- "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "httpAuthenticationPassword": "string",
- "httpAuthenticationUsername": "string",
- "uri": "string",
- "version": "string"
}{- "actions": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "serviceActionOutcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "id": "string"
}
], - "serviceInputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "isRequired": true,
- "order": 0,
- "typeElementDeveloperName": "string"
}
], - "serviceOutputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "isRequired": true,
- "order": 0,
- "typeElementDeveloperName": "string"
}
], - "uriPart": "string"
}
], - "types": [
- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
], - "version": "string"
}Used to list and filter existing service elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
Success
[- {
- "actions": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "isViewMessageAction": true,
- "serviceActionOutcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "id": "string"
}
], - "serviceInputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceOutputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "uriPart": "string"
}
], - "configurationValues": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "format": "string",
- "httpAuthenticationPassword": "string",
- "httpAuthenticationUsername": "string",
- "id": "string",
- "install": {
- "typeElements": [
- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]
}, - "providesAutoBinding": true,
- "providesDatabase": true,
- "providesFiles": true,
- "providesIdentity": true,
- "providesLocation": true,
- "providesLogic": true,
- "providesSocial": true,
- "providesViews": true,
- "sendDecryptedValues": true,
- "updateByName": true,
- "uri": "string",
- "version": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create new service elements or update existing ones.
| actions | Array of objects (ServiceActionRequestAPI) The list of 'logic' operations that are available for the service. If the underlying service 'providesLogic', this is where the 'interface' for those logic operations should be stored. This allows the author to know what inputs and outputs are provided by the actions provided by this Service. |
| configurationValues | Array of objects (ServiceValueRequestAPI) The list of configuration value mappings the service needs to function. Each entry provides a reference to a Value in the Flow that contains the configuration value needed by the service plugin. |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| format | string The REST messaging format to use to communicate with this service. Currently the only valid value for this property is: JSON |
| httpAuthenticationPassword | string |
| httpAuthenticationUsername | string |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| install | object (ServiceInstallRequestAPI) |
| providesAutoBinding | boolean |
| providesDatabase | boolean Indicates if the Service provides functionality for 'database'. Database functionality allows the author to map their Typed Objects and Lists back to this service for storage. The service then acts as the persistence implementation to store and retrieve the data as neede by the Flow. |
| providesFiles | boolean Indicates if the Service provides functionality for 'files'. Files allows the author to reference files and content from the service as dynamic references - meaning that the files and content can be managed outside of ManyWho, but embedded in your Flows. |
| providesIdentity | boolean Indicates if the Service provides functionality for 'identity'. Identity functionality allows the author to manage permissions to their Flows and sections of their Flows (via Swimlanes) using this service as the directory. This also allows users to login to the Flows using the information stored in this service directory. |
| providesLocation | boolean Indicates if the Service provides functionality for 'location'. ManyWho optionally collects location information about the user when running a Flow. This information can be used to make decisions about permissions and also data filtering - though it is up to the service to implement this functionality. |
| providesLogic | boolean Indicates if the Service provides functionality for 'logic'. Logic allows authors to make API calls as part of elements that support messaging: 'Message', 'Page', and 'Remote Page' currently. Messaging is used for asynchronous and synchronous use-cases. |
| providesSocial | boolean Indicates if the Service provides functionality for 'social'. Social allows the author to add features for feed, file and user collaboration to their Flows using this service as the underlying social network. |
| providesViews | boolean Indicates if the Service provides functionality for 'views'. A View allows authors to build Flows that include 'Remote Page' elements - e.g. the UI of the page is not actually hosted on the ManyWho platform, but rather the UI is provided by the external service. |
| sendDecryptedValues | boolean |
| updateByName | boolean Indicates if the platform should attempt to find a Service with the same developer name as the one provided and match them up by name as opposed to 'id'. This is useful when creating scripts to create Flows - as you can use the developerName property as the reference as opposed to needing to know the ids of all created elements. |
| uri | string The location of the Service implementation for the platform to callout against. |
| version | string |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
Success
{- "actions": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "isViewMessageAction": true,
- "serviceActionOutcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "id": "string"
}
], - "serviceInputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceOutputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "uriPart": "string"
}
], - "configurationValues": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "format": "string",
- "httpAuthenticationPassword": "string",
- "httpAuthenticationUsername": "string",
- "id": "string",
- "install": {
- "typeElements": [
- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]
}, - "providesAutoBinding": true,
- "providesDatabase": true,
- "providesFiles": true,
- "providesIdentity": true,
- "providesLocation": true,
- "providesLogic": true,
- "providesSocial": true,
- "providesViews": true,
- "sendDecryptedValues": true,
- "updateByName": true,
- "uri": "string",
- "version": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}{- "actions": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "isViewMessageAction": true,
- "serviceActionOutcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "id": "string"
}
], - "serviceInputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceOutputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "uriPart": "string"
}
], - "configurationValues": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "format": "string",
- "httpAuthenticationPassword": "string",
- "httpAuthenticationUsername": "string",
- "id": "string",
- "install": {
- "typeElements": [
- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]
}, - "providesAutoBinding": true,
- "providesDatabase": true,
- "providesFiles": true,
- "providesIdentity": true,
- "providesLocation": true,
- "providesLogic": true,
- "providesSocial": true,
- "providesViews": true,
- "sendDecryptedValues": true,
- "updateByName": true,
- "uri": "string",
- "version": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get an existing service element.
| id required | string <uuid> The unique identifier for the service element |
Success
{- "actions": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "isViewMessageAction": true,
- "serviceActionOutcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "id": "string"
}
], - "serviceInputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceOutputs": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "uriPart": "string"
}
], - "configurationValues": [
- {
- "contentType": "string",
- "developerName": "string",
- "order": 0,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "format": "string",
- "httpAuthenticationPassword": "string",
- "httpAuthenticationUsername": "string",
- "id": "string",
- "install": {
- "typeElements": [
- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]
}, - "providesAutoBinding": true,
- "providesDatabase": true,
- "providesFiles": true,
- "providesIdentity": true,
- "providesLocation": true,
- "providesLogic": true,
- "providesSocial": true,
- "providesViews": true,
- "sendDecryptedValues": true,
- "updateByName": true,
- "uri": "string",
- "version": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}The tag element object provides additional runtime data to your page element containers/components and navigation elements/items.
The purpose of the tag element is to add flexibility to your flow application user experience. The components,
containers and navigation items in your flow can benefit from having access to the flow state to get more
contextual information. For example, if you have a numeric input field, it may be useful to know the possible
range or numeric values that can be provided by the end user - where that range depends on logic in the flow.
The components, containers and navigation items also supports attributes and these are often
sufficient for many use-cases. As a result, only use the tag element if you need information that is very
specific to the flow state for particular running user(s).
Used to list and filter existing tag elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
Success
[- {
- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create new tag elements or update existing ones.
| contentType | string The type of Value the Tag holds. As part of the Page layout creation, the Tag will be associated with a Value. The Value bound to this Tag must be of the same content type. |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| typeElementId | string The unique identifier for the Type and object or list data must adhere to in structure (the Type basically defines the 'interface' that all objects and lists stored in this Value must implement). This property is only applicable for ContentObject and ContentList content types. As part of the Page layout creation, the Tag will be associated with a Value. The Value bound to this Tag must be of the same Type. |
| updateByName | boolean Indicates if the platform should attempt to find a Tag with the same developer name as the one provided and match them up by name as opposed to 'id'. This is useful when creating scripts to create Flows - as you can use the developerName property as the reference as opposed to needing to know the ids of all created Elements. |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
Success
{- "contentType": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}{- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get an existing tag element.
| id required | string <uuid> The unique identifier for the tag element |
Success
{- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}The type element object defines the structure of objects and lists in the flow.
The purpose of the type element is to allow flow builders to determine the business objects that will be used in the flow. Often the type elements are provided when the flow builder installs a new service element, however, flow builders can define their own type elements as needed to support the objectives of the flow. The type element also provides the bindings back to the service elements that can save, read or delete data of the same structure. As a result, the type element maps from friendly business objects to underlying storage implementations as provided by the service element. The base properties of the type element are outlined here.
A binding is used to map properties in the type to database fields in the service. The mapping does not need to be directly to database tables in the service, however, the binding should provide unique identifier information necessary for the service element to put the provided values back to the correct storage locations. The binding is typically pre-configured as part of the type installation process. However, it is possible for flow builders to define bindings manually.
Used to list and filter existing type elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
Success
[- {
- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create new type elements or update existing ones.
| overrideService | boolean Default: false Whether to allow updates to a type that is associated with a service |
| bindings | Array of objects (TypeElementBindingAPI) The list of bindings for the Type. A binding holds the mapping of properties to tables and fields in an underlying Service. A binding is not required for a Type if there is no plan to save the data in an external data store. When creating a binding, you will need to have saved the initial Type first so you have the identifiers for the various properties in the Type that need to be bound. |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| properties | Array of objects (TypeElementPropertyAPI) The list of properties for this Type. A property is very similar to a field in a table - it represents the structure of the data that will be stored in Values that use this Type. |
| serviceElementDeveloperName | string |
| serviceElementId | string |
| updateByName | boolean Indicates if the platform should attempt to find a Type with the same developer name as the one provided and match them up by name as opposed to 'id'. This is useful when creating scripts to create Flows - as you can use the developerName property as the reference as opposed to needing to know the ids of all created Elements. |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
Success
{- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}{- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get an existing type element.
| id required | string <uuid> The unique identifier for the type element |
Success
{- "bindings": [
- {
- "databaseTableName": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "propertyBindings": [
- {
- "databaseContentType": "string",
- "databaseFieldName": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string"
}
], - "serviceElementId": "string",
- "typeElementId": "string"
}
], - "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "id": "string",
- "typeElementDeveloperName": "string",
- "typeElementId": "string"
}
], - "serviceElementDeveloperName": "string",
- "serviceElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}The value element object stores data collected in the flow state.
The purpose of the value element is to allow flow builders to determine how data collected from running user(s) or external services will be stored and used. The value element represents the memory for the flow application so data gathered can be later saved, updated, or viewed. The base properties of the value element are outlined here.
Used to list and filter existing value elements.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of elements where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of elements where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
| contentType | Array of strings Optional. One or more content types to filter by |
Success
[- {
- "access": "string",
- "contentFormat": "string",
- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "defaultContentValue": "string",
- "defaultObjectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "initializationOperations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "isFixed": true,
- "isVersionless": true,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]Used to create new value elements or update existing ones.
| access | string Sets the level of access this Value has to change. In many situations, Values can only be changed by the operations defined in your Flow and the value is not exposed outside of the Flow. Alternatively, you may wish to allow the value of the Value to be assigned at initialization. |
| contentFormat | string |
| contentType | string The type of content the Value holds. |
| defaultContentValue | string The default content value for the Value before any operations have been performed. This is for primitive Values. |
| defaultObjectData | Array of objects (ObjectAPI) The default object data for the Value before any operations have been performed. This is for Object and List Values. |
| developerName | string The developer name for the element. This is useful for keeping track of the element in the modelling tool and the API. |
| developerSummary | string The developer summary the author provided to give more information about the element |
| elementType | string The type of element this metadata represents. |
| id | string The unique identifier for the element. The id should be null for "insert" requests and a valid identifier for "update" requests. |
| initializationOperations | Array of objects (OperationAPI) The operations that should be performed when the object is initialized. Initialization operations are only appropriate for Values of content type ContentObject. |
| isFixed | boolean Indicates if the value of the Value can be changed by operations in the Flow or from outside systems. If this property is set to 'true', the Value will act like a 'constant' - i.e. it can't be changed by anyone except the Flow author at design time. |
| isVersionless | boolean |
| typeElementDeveloperName | string |
| typeElementId | string The unique identifier for the Type and object or list data must adhere to in structure (the Type basically defines the 'interface' that all objects and lists stored in this Value must implement). This property is only applicable for ContentObject and ContentList content types. |
| updateByName | boolean Indicates if the platform should attempt to find a Value with the same developer name as the one provided and match them up by name as opposed to 'id'. This is useful when creating scripts to create Flows - as you can use the developerName property as the reference as opposed to needing to know the ids of all created Elements. |
| whoCreated | object (BuilderWhoAPI) |
| whoModified | object (BuilderWhoAPI) |
| whoOwner | object (BuilderWhoAPI) |
Success
{- "access": "string",
- "contentFormat": "string",
- "contentType": "string",
- "defaultContentValue": "string",
- "defaultObjectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "initializationOperations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "isFixed": true,
- "isVersionless": true,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}{- "access": "string",
- "contentFormat": "string",
- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "defaultContentValue": "string",
- "defaultObjectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "initializationOperations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "isFixed": true,
- "isVersionless": true,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to get an existing value element.
| id required | string <uuid> The unique identifier for the value element |
Success
{- "access": "string",
- "contentFormat": "string",
- "contentType": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "defaultContentValue": "string",
- "defaultObjectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "initializationOperations": [
- {
- "disabled": true,
- "macroElementToExecuteDeveloperName": "string",
- "macroElementToExecuteId": "string",
- "order": 0,
- "valueElementToApplyCommand": "string",
- "valueElementToApplyCommandFriendly": "string",
- "valueElementToApplyContentType": "string",
- "valueElementToApplyDeveloperName": "string",
- "valueElementToApplyId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToApplyTypeElementId": "string",
- "valueElementToReferenceCommand": "string",
- "valueElementToReferenceCommandFriendly": "string",
- "valueElementToReferenceContentType": "string",
- "valueElementToReferenceDeveloperName": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}, - "valueElementToReferenceTypeElementId": "string"
}
], - "isFixed": true,
- "isVersionless": true,
- "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "updateByName": true,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Get the execution log of a state
| flowId required | string |
| stateId required | string |
Success
{- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "entries": {
- "property1": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}, - "property2": {
- "data": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "level": "info",
- "message": "string",
- "timestamp": "2020-02-18T14:27:31Z",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
}, - "flowDeveloperName": "string",
- "flowId": "string",
- "id": "string",
- "stateId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}The notifications API allows you to view any notifications sent to your or inside your tenant.
Get all the notifications that have been sent from inside a tenant
| type | string Filter by type, currently supports: delete_all, delete_tenant, fault, password_reset, tenant_creation, warning |
Success
[- {
- "content": "string",
- "createdAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isRead": true,
- "subject": "string",
- "tenant": {
- "developerName": "string",
- "id": "string"
}, - "type": "string",
- "userId": "string"
}
]Get all the unread notifications that have been sent to the currently logged in user, across all tenants
| type | string Filter by type, currently supports: delete_all, delete_tenant, fault, password_reset, tenant_creation, warning |
| includeRead | boolean Default: false Also include read eamil. |
Success
[- {
- "content": "string",
- "createdAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isRead": true,
- "subject": "string",
- "tenant": {
- "developerName": "string",
- "id": "string"
}, - "type": "string",
- "userId": "string"
}
]Finds the notification and marks it as read
| id required | string <uuid> |
Success
{- "content": "string",
- "createdAt": "2020-02-18T14:27:31Z",
- "id": "string",
- "isRead": true,
- "subject": "string",
- "tenant": {
- "developerName": "string",
- "id": "string"
}, - "type": "string",
- "userId": "string"
}The packaging API allows you to move a Flow from one tenant to another. This can be handy for a few example reasons:
Create a package of the latest version of a flow snapshot
| id required | string The ID of the flow |
| nullPasswords | boolean Default: false Whether the package should include password values. |
Success
"string"Get the package of a specific version of a Flow Snapshot
| id required | string The ID of the flow |
| version required | string The version of the flow |
| nullPasswords | boolean Default: true Whether the package should include password values. |
Success
"string"This allows you to import a flow package into a Tenant. It’s important to note that this is not the same as cloning a flow. If you import a flow package into a tenant that contains a flow with the same flow ID, the flow in the target tenant will be overwritten with the flow package being imported.
| isSnapshot | boolean Default: false Optional. Whether the package should be imported directly as a snapshot, and not modelling data |
| isActive | boolean Default: false Optional. Whether the package should be imported as an active snapshot ( |
| isDefault | boolean Default: false Optional. Whether the package should be immediately made the default version ( |
| uriMapping | Array of any |
| overwriteExisting | boolean Default: true Whether to overwrite any elements that already exist in the tenant with the versions included in the package. Enabled by default. |
The package content
The package was successfully imported
The package wasn't imported, as there are conflicting elements in the tenant
"string"{- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}The player content should be sent as application/x-www-form-urlencoded; charset=UTF8 request
with the body of the request set to =player content goes here
| tenantId required | string <uuid> |
| playerName required | string |
| player | string |
Success
| name required | string The name of the flow to load |
Success
{- "alertEmail": "string",
- "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "startMapElementId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}| id required | string <uuid> The ID of the flow to load |
Success
{- "alertEmail": "string",
- "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "startMapElementId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}Used to list and filter existing snapshotted flows.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of flows where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of flows where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
Success
[- {
- "alertEmail": "string",
- "comment": "string",
- "dateCreated": "2020-02-18T14:27:31Z",
- "dateModified": "2020-02-18T14:27:31Z",
- "developerName": "string",
- "developerSummary": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "startMapElementId": "string",
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]The Run API provides all of the features of your executing Flow applications. When you build a Flow on the ManyWho Platform, it is exposed through this API:
The Run API is perhaps the most important part of the Platform as it represents everything that is needed to run your Flow applications.
Used to authenticate with OAuth 1.0a.
| oauth_token | string The OAuth authentication token to authenticate with. |
| oauth_verifier | string The OAuth authentication verifier to authenticate with. |
| oauth_error | string |
Success
Used to authenticate with OAuth 2.0.
| code | string The OAuth authentication code the authenticate with. |
| state | string The OAuth authentication state the authenticate with. |
| error | string Provide an error code to throw an error with that code. |
| error_description | string The error description to throw with the error code. |
Success
When you initialize a Flow, you are provided with the authentication context in the response.
However, you can also retrieve and login to Services individually.
It’s important to note that despite authentication being done against a Flow state, the returned Runtime Authentication Token is valid across all Flow States.
| stateId required | string The unique identifier of the Flow state. |
| serviceElementId | string The serviceElmentId of the Service to get the authentication context of. |
Success
{- "authenticationType": "string",
- "directoryId": "string",
- "directoryName": "string",
- "loginUrl": "string"
}Authenticate with the given authentication credentials to the given state
| stateId required | string The unique identifier of the Flow state to authenticate to. |
| serviceElementId | string The Service element id of the Service to authenticate to. |
| authenticationType | string The type of authentication being performed |
| code | string The OAuth2 code |
| configurationValues | Array of objects (EngineValueAPI) Any additional configuration values that may have been applied by the engine to help with authentication. |
| instanceUrl | string The particular instance of the directory. For services such as salesforce.com, this is either "https://login.salesforce.com" (default) or "https://test.salesforce.com". |
| loginUrl | string The REST endpoint for the plugin providing the identity |
| password | string The password for your account in the directory |
| platformUri | string The URI of the Flow platform that sent the request |
| redirectUri | string The OAuth2 redirect URI |
| sessionToken | string The session token for the directory. For services such as salesforce.com, this is the sessionId |
| sessionUrl | string The session URL for the directory. For services such as salesforce.com, this is the pod instance you are currently logged into |
| tenantId | string |
| token | string The account token for the directory. For OAuth2 integration, this the access token |
| username | string The username for your account in the directory |
| verifier | string The OAuth1.0 verifier |
Success
{- "authenticationType": "string",
- "code": "string",
- "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "instanceUrl": "string",
- "loginUrl": "string",
- "password": "string",
- "platformUri": "string",
- "redirectUri": "string",
- "sessionToken": "string",
- "sessionUrl": "string",
- "tenantId": "string",
- "token": "string",
- "username": "string",
- "verifier": "string"
}"string"Check if the currently authenticated user has permission to access the state at its current position
| state required | string <uuid> The unique identifier of the Flow state to check the current user against. |
Success
Initiate a flow out from an Outcome that is configured with a Flow Out.
| stateId required | string The unique identifier of the Flow state. |
| selectedOutcomeId required | string The outcome to Flow Out through. |
Success
{- "authorizationContext": {
- "authenticationType": "string",
- "directoryId": "string",
- "directoryName": "string",
- "loginUrl": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "currentStreamId": "string",
- "navigationElementReferences": [
- {
- "developerName": "string",
- "id": "string"
}
], - "stateId": "string",
- "stateToken": "string",
- "statusCode": "string"
}Used to initialize a flow
| annotations | object Annotations take the form of {"mykey":"myvalue"}. Any annotations added to the State will be persisted for the duration of the Flow. Annotations are passed to the executing player and also through to Services. Annotations can be changed at any time through the execution of the Flow. |
| externalIdentifier | string An arbitrary external identifier that can be used to query for a State. |
| flowId | object (FlowIdAPI) A composite unique identifier assigned by the platform, which should not be included for new flows. |
| inputs | Array of objects (EngineValueAPI) An array of engine value objects that will be used to assign values in the flow at initialization. |
| joinPlayerUrl | string The location of the player that should be used for sharing and notifications when joining a running flow. The service will automatically append the "join" parameter to this url so the player knows which flow and state it is playing (the "join" parameter is the state identifier). |
| mode | string The mode you wish to run the flow in. The mode is mainly useful for debugging purposes as you can step through the flow and also view state information to check everything is working as expected. |
| parentStateId | string The unique identifier for the parent State that "spawned" this State. This property is assigned when a Flow calls a Sub-Flow. The Sub-Flow will have this property assigned referencing the parent Flow. |
| playerUrl | string The location of the player that should be used for sharing and notifications when first running the flow. The service will automatically append the "flow-id" parameter to this url so the player knows which flow it is playing. |
| reportingMode | string The reporting mode under which you want to run this State of a Flow. |
| stateId | string The unique identifier for an existing State. This parameter should be used if the first initialization request was rejected due to access being denied due to authentication. If you do not re-use this stateId property, your inputs will not be correctly assigned. |
Success
{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "externalIdentifier": "string",
- "flowId": {
- "id": "string",
- "versionId": "string"
}, - "inputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "joinPlayerUrl": "string",
- "mode": "string",
- "parentStateId": "string",
- "playerUrl": "string",
- "reportingMode": "string",
- "stateId": "string"
}{- "authorizationContext": {
- "authenticationType": "string",
- "directoryId": "string",
- "directoryName": "string",
- "loginUrl": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "currentStreamId": "string",
- "navigationElementReferences": [
- {
- "developerName": "string",
- "id": "string"
}
], - "stateId": "string",
- "stateToken": "string",
- "statusCode": "string"
}Used to initialise a flow and authenitcate into it.
The details of the Flow with a username and password to authenticate with.
| developerName | string |
| id | string <uuid> |
| inputs | Array of objects (EngineValueAPI) |
| password | string |
| username | string |
| versionId | string <uuid> |
Success
{- "developerName": "string",
- "id": "string",
- "inputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "password": "string",
- "username": "string",
- "versionId": "string"
}{- "alertEmail": "string",
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationContext": {
- "authenticationType": "string",
- "directoryId": "string",
- "directoryName": "string",
- "loginUrl": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "currentStreamId": "string",
- "frames": [
- {
- "flowId": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string"
}
], - "invokeType": "string",
- "joinFlowUri": "string",
- "mapElementInvokeResponses": [
- {
- "developerName": "string",
- "mapElementId": "string",
- "outcomeResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "id": "string",
- "isBulkAction": true,
- "isOut": true,
- "label": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageResponse": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "label": "string",
- "order": 0,
- "pageComponentDataResponses": [
- {
- "content": "string",
- "contentValue": "string",
- "fileDataRequest": {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "limit": 0,
- "offset": 0,
- "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string"
}, - "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string",
- "stateId": "string",
- "token": "string"
}, - "imageUri": "string",
- "isEditable": true,
- "isEnabled": true,
- "isRequired": true,
- "isValid": true,
- "isVisible": true,
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "objectDataRequest": {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "id": "string",
- "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}
], - "offset": 0,
- "offsetToken": "string",
- "orderBy": [
- {
- "columnName": "string",
- "direction": "string"
}
], - "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string",
- "searchCriteria": [
- {
- "columnName": "string"
}
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}, - "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "objectDataType": {
- "developerName": "string",
- "properties": [
- {
- "developerName": "string",
- "list": [
- { }
]
}
], - "typeElementId": "string"
}, - "stateId": "string",
- "token": "string",
- "typeElementBindingId": "string"
}, - "pageComponentId": "string",
- "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "validationMessage": "string"
}
], - "pageComponentResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "componentType": "string",
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "contentType": "string",
- "developerName": "string",
- "hasEvents": true,
- "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "isMultiSelect": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "width": 0
}
], - "pageContainerDataResponses": [
- {
- "isEditable": true,
- "isEnabled": true,
- "isVisible": true,
- "pageContainerId": "string",
- "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]
}
], - "pageContainerResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainerResponses": [
- { }
]
}
], - "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}
}
], - "navigationElementReferences": [
- {
- "developerName": "string",
- "id": "string"
}
], - "notAuthorizedMessage": "string",
- "outputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "parentStateId": "string",
- "preCommitStateValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "runFlowUri": "string",
- "stateId": "string",
- "stateLog": {
- "stateLogEntries": [
- {
- "engineInvokeRequest": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "geoLocation": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "invokeType": "string",
- "mapElementInvokeRequest": {
- "pageRequest": {
- "pageComponentInputResponses": [
- {
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "pageComponentId": "string"
}
]
}, - "selectedOutcomeId": "string"
}, - "mode": "string",
- "navigationElementId": "string",
- "selectedMapElementId": "string",
- "selectedNavigationItemId": "string",
- "stateId": "string",
- "stateToken": "string"
}, - "engineInvokeResponse": { },
- "isActive": "string",
- "stateLogEntryInvokePairs": [
- {
- "engineInvokeRequest": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "geoLocation": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}, - "invokeType": "string",
- "mapElementInvokeRequest": {
- "pageRequest": {
- "pageComponentInputResponses": [
- {
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "pageComponentId": "string"
}
]
}, - "selectedOutcomeId": "string"
}, - "mode": "string",
- "navigationElementId": "string",
- "selectedMapElementId": "string",
- "selectedNavigationItemId": "string",
- "stateId": "string",
- "stateToken": "string"
}, - "engineInvokeResponse": { },
- "order": "string"
}
], - "timeStamp": "string"
}
]
}, - "stateToken": "string",
- "stateValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "statusCode": "string",
- "voteResponse": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "isComplete": true,
- "minimumCount": 0,
- "minimumPercent": 0,
- "selectedOutcomeId": "string",
- "userVotes": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:31Z"
}
], - "voteType": "string"
}, - "waitMessage": "string"
}Used to join the state provided
| stateId required | string The unique identifier of the Flow state. |
| mode | string The mode in which to join the state. |
Success
{- "alertEmail": "string",
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationContext": {
- "authenticationType": "string",
- "directoryId": "string",
- "directoryName": "string",
- "loginUrl": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "currentStreamId": "string",
- "frames": [
- {
- "flowId": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string"
}
], - "invokeType": "string",
- "joinFlowUri": "string",
- "mapElementInvokeResponses": [
- {
- "developerName": "string",
- "mapElementId": "string",
- "outcomeResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "id": "string",
- "isBulkAction": true,
- "isOut": true,
- "label": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageResponse": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "label": "string",
- "order": 0,
- "pageComponentDataResponses": [
- {
- "content": "string",
- "contentValue": "string",
- "fileDataRequest": {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "limit": 0,
- "offset": 0,
- "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string"
}, - "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string",
- "stateId": "string",
- "token": "string"
}, - "imageUri": "string",
- "isEditable": true,
- "isEnabled": true,
- "isRequired": true,
- "isValid": true,
- "isVisible": true,
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "objectDataRequest": {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "id": "string",
- "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}
], - "offset": 0,
- "offsetToken": "string",
- "orderBy": [
- {
- "columnName": "string",
- "direction": "string"
}
], - "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string",
- "searchCriteria": [
- {
- "columnName": "string"
}
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}, - "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "objectDataType": {
- "developerName": "string",
- "properties": [
- {
- "developerName": "string",
- "list": [
- { }
]
}
], - "typeElementId": "string"
}, - "stateId": "string",
- "token": "string",
- "typeElementBindingId": "string"
}, - "pageComponentId": "string",
- "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "validationMessage": "string"
}
], - "pageComponentResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "componentType": "string",
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "contentType": "string",
- "developerName": "string",
- "hasEvents": true,
- "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "isMultiSelect": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "width": 0
}
], - "pageContainerDataResponses": [
- {
- "isEditable": true,
- "isEnabled": true,
- "isVisible": true,
- "pageContainerId": "string",
- "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]
}
], - "pageContainerResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainerResponses": [
- { }
]
}
], - "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}
}
], - "navigationElementReferences": [
- {
- "developerName": "string",
- "id": "string"
}
], - "notAuthorizedMessage": "string",
- "outputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "parentStateId": "string",
- "preCommitStateValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "runFlowUri": "string",
- "stateId": "string",
- "stateLog": {
- "stateLogEntries": [
- {
- "engineInvokeRequest": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "geoLocation": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "time": "2020-02-18T14:27:32Z"
}, - "invokeType": "string",
- "mapElementInvokeRequest": {
- "pageRequest": {
- "pageComponentInputResponses": [
- {
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "pageComponentId": "string"
}
]
}, - "selectedOutcomeId": "string"
}, - "mode": "string",
- "navigationElementId": "string",
- "selectedMapElementId": "string",
- "selectedNavigationItemId": "string",
- "stateId": "string",
- "stateToken": "string"
}, - "engineInvokeResponse": { },
- "isActive": "string",
- "stateLogEntryInvokePairs": [
- {
- "engineInvokeRequest": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "geoLocation": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "time": "2020-02-18T14:27:32Z"
}, - "invokeType": "string",
- "mapElementInvokeRequest": {
- "pageRequest": {
- "pageComponentInputResponses": [
- {
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "pageComponentId": "string"
}
]
}, - "selectedOutcomeId": "string"
}, - "mode": "string",
- "navigationElementId": "string",
- "selectedMapElementId": "string",
- "selectedNavigationItemId": "string",
- "stateId": "string",
- "stateToken": "string"
}, - "engineInvokeResponse": { },
- "order": "string"
}
], - "timeStamp": "string"
}
]
}, - "stateToken": "string",
- "stateValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "statusCode": "string",
- "voteResponse": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "isComplete": true,
- "minimumCount": 0,
- "minimumPercent": 0,
- "selectedOutcomeId": "string",
- "userVotes": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:32Z"
}
], - "voteType": "string"
}, - "waitMessage": "string"
}Used to invoke a flow state
| stateId required | string The unique identifier of the Flow state. |
| annotations | object Key value pairs you wish to annotate to the flow. Annotations take the form of {"mykey":"myvalue"}. Any annotations added to the state will be persisted for the duration of the flow. Annotations are passed to the executing player and also through to plugin services. Annotations can be changed at any time through the execution of the flow. |
| culture | object (CultureAPI) |
| currentMapElementId | string The unique identifier for the map element the user is currently executing against. |
| geoLocation | object (GeoLocationAPI) |
| invokeType | string The way you want to invoke the engine as part of this request. The user may be navigating forward, or you may be wanting to perform a sync operation to update the UI due to another user making a change. |
| mapElementInvokeRequest | object (MapElementInvokeRequestAPI) |
| mode | string The mode you wish to run the flow in. The mode is mainly useful for debugging purposes as you can step through the flow and also view state information to check everything is working as expected. |
| navigationElementId | string The unique identifier for the navigation element that's being used to drive the navigation scheme. |
| selectedMapElementId | string When executing a Flow that has the allowJumping property set to 'true', the user can move to any Map Element in the Flow regardless of navigation or outcomes. This is the unique identifier of the Map Element the user wishes to navigate to and must be used with an InvokeType of 'NAVIGATE'. |
| selectedNavigationItemId | string When executing using an InvokeType of 'NAVIGATE', this is the selected navigation item the user wishes to move to in the Flow. |
| stateId | string The unique identifier for the initialized flow state. The state identifier is needed throughout the execution of the flow as it is the pointer that points the engine to the correct running instance of a flow. |
| stateToken | string The unique identifier for the token response from the state. The state token identifier changes with every cycle of request/response. The token is needed as it tells the engine how in-sync your request is with the current service side state. |
Success
{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "geoLocation": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "time": "2020-02-18T14:27:32Z"
}, - "invokeType": "string",
- "mapElementInvokeRequest": {
- "pageRequest": {
- "pageComponentInputResponses": [
- {
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "pageComponentId": "string"
}
]
}, - "selectedOutcomeId": "string"
}, - "mode": "string",
- "navigationElementId": "string",
- "selectedMapElementId": "string",
- "selectedNavigationItemId": "string",
- "stateId": "string",
- "stateToken": "string"
}{- "alertEmail": "string",
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "authorizationContext": {
- "authenticationType": "string",
- "directoryId": "string",
- "directoryName": "string",
- "loginUrl": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "currentStreamId": "string",
- "frames": [
- {
- "flowId": "string",
- "mapElementDeveloperName": "string",
- "mapElementId": "string"
}
], - "invokeType": "string",
- "joinFlowUri": "string",
- "mapElementInvokeResponses": [
- {
- "developerName": "string",
- "mapElementId": "string",
- "outcomeResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "developerName": "string",
- "id": "string",
- "isBulkAction": true,
- "isOut": true,
- "label": "string",
- "order": 0,
- "pageActionBindingType": "string",
- "pageActionType": "string",
- "pageObjectBindingId": "string"
}
], - "pageResponse": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "label": "string",
- "order": 0,
- "pageComponentDataResponses": [
- {
- "content": "string",
- "contentValue": "string",
- "fileDataRequest": {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "limit": 0,
- "offset": 0,
- "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string"
}, - "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string",
- "stateId": "string",
- "token": "string"
}, - "imageUri": "string",
- "isEditable": true,
- "isEnabled": true,
- "isRequired": true,
- "isValid": true,
- "isVisible": true,
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "objectDataRequest": {
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "id": "string",
- "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}
], - "offset": 0,
- "offsetToken": "string",
- "orderBy": [
- {
- "columnName": "string",
- "direction": "string"
}
], - "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string",
- "searchCriteria": [
- {
- "columnName": "string"
}
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}, - "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "objectDataType": {
- "developerName": "string",
- "properties": [
- {
- "developerName": "string",
- "list": [
- { }
]
}
], - "typeElementId": "string"
}, - "stateId": "string",
- "token": "string",
- "typeElementBindingId": "string"
}, - "pageComponentId": "string",
- "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "validationMessage": "string"
}
], - "pageComponentResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "columns": [
- {
- "componentType": "string",
- "contentFormat": "string",
- "contentType": "string",
- "developerName": "string",
- "isDisplayValue": true,
- "isEditable": true,
- "label": "string",
- "order": 0,
- "typeElementPropertyId": "string",
- "typeElementPropertyToDisplayId": "string"
}
], - "componentType": "string",
- "contentType": "string",
- "developerName": "string",
- "hasEvents": true,
- "height": 0,
- "helpInfo": "string",
- "hintValue": "string",
- "id": "string",
- "isMultiSelect": true,
- "isSearchable": true,
- "label": "string",
- "maxSize": 0,
- "order": 0,
- "pageContainerDeveloperName": "string",
- "pageContainerId": "string",
- "size": 0,
- "width": 0
}
], - "pageContainerDataResponses": [
- {
- "isEditable": true,
- "isEnabled": true,
- "isVisible": true,
- "pageContainerId": "string",
- "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]
}
], - "pageContainerResponses": [
- {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "containerType": "string",
- "developerName": "string",
- "id": "string",
- "label": "string",
- "order": 0,
- "pageContainerResponses": [
- { }
]
}
], - "tags": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]
}, - "rootFaults": {
- "property1": "string",
- "property2": "string"
}
}
], - "navigationElementReferences": [
- {
- "developerName": "string",
- "id": "string"
}
], - "notAuthorizedMessage": "string",
- "outputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "parentStateId": "string",
- "preCommitStateValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "runFlowUri": "string",
- "stateId": "string",
- "stateLog": {
- "stateLogEntries": [
- {
- "engineInvokeRequest": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "geoLocation": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "time": "2020-02-18T14:27:32Z"
}, - "invokeType": "string",
- "mapElementInvokeRequest": {
- "pageRequest": {
- "pageComponentInputResponses": [
- {
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "pageComponentId": "string"
}
]
}, - "selectedOutcomeId": "string"
}, - "mode": "string",
- "navigationElementId": "string",
- "selectedMapElementId": "string",
- "selectedNavigationItemId": "string",
- "stateId": "string",
- "stateToken": "string"
}, - "engineInvokeResponse": { },
- "isActive": "string",
- "stateLogEntryInvokePairs": [
- {
- "engineInvokeRequest": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "currentMapElementId": "string",
- "geoLocation": {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "time": "2020-02-18T14:27:32Z"
}, - "invokeType": "string",
- "mapElementInvokeRequest": {
- "pageRequest": {
- "pageComponentInputResponses": [
- {
- "contentValue": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "pageComponentId": "string"
}
]
}, - "selectedOutcomeId": "string"
}, - "mode": "string",
- "navigationElementId": "string",
- "selectedMapElementId": "string",
- "selectedNavigationItemId": "string",
- "stateId": "string",
- "stateToken": "string"
}, - "engineInvokeResponse": { },
- "order": "string"
}
], - "timeStamp": "string"
}
]
}, - "stateToken": "string",
- "stateValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "statusCode": "string",
- "voteResponse": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "isComplete": true,
- "minimumCount": 0,
- "minimumPercent": 0,
- "selectedOutcomeId": "string",
- "userVotes": [
- {
- "accuracy": 0,
- "altitude": 0,
- "altitudeAccuracy": 0,
- "directoryUserId": "string",
- "heading": 0,
- "latitude": 0,
- "longitude": 0,
- "manywhoUserId": "string",
- "selectedOutcomeId": "string",
- "speed": 0,
- "time": "2020-02-18T14:27:32Z"
}
], - "voteType": "string"
}, - "waitMessage": "string"
}Used to get the invoke type of the service response provided
| annotations | object Any runtime annotations that were provided to the State plus any additional annotations the Service may be providing. |
| culture | object (CultureAPI) |
| invokeType | string Tells the engine what this service would like it to do. At the moment, there are really only two possible commands: WAIT (to tell the engine to wait for a completed response) or DONE (to tell the engine that it has completed its work. |
| mode | string The mode which the Service would like the Flow State to execute under. |
| outputs | Array of objects (EngineValueAPI) The output values from the Service being sent back to the Flow State. Outputs will be applied to the Flow State even if the InvokeType is set to WAIT. |
| rootFaults | object Any faults that have happened in the Service that should be reported up to the Flow State. |
| selectedOutcomeId | string The Outcome the Service would like the Flow to follow. If the Outcome has Rules, the Service request for this outcome will be ignored unless the Rules are also satisfied. |
| tenantId | string The unique identifier for the tenant that made the request to the Service. |
| token | string The execution token needed for any callback responses from the Service. |
| valueFaults | Array of objects (ValueFaultAPI) Any faults that are directly attributed to an input value provided in the ServiceRequest. If a ValueFault is specified, ManyWho will attempt to match this error with any input fields that are bound to that Value. |
| waitMessage | string The "wait" message that should be provided to users waiting for the Service to complete its tasks. |
Success
{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "invokeType": "string",
- "mode": "string",
- "outputs": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "rootFaults": {
- "property1": "string",
- "property2": "string"
}, - "selectedOutcomeId": "string",
- "tenantId": "string",
- "token": "string",
- "valueFaults": [
- {
- "faultCode": "string",
- "faultMessage": "string",
- "valueElementToReferenceId": "string",
- "valueElementTypeElementPropertyToReferenceId": "string"
}
], - "waitMessage": "string"
}"string"Used to get the invoke type of the service event provided
| annotations | object Any runtime annotations that were provided to the State plus any additional annotations the Service may be providing. |
| culture | object (CultureAPI) |
| listeningEventValue | object (EngineValueAPI) |
| tenantId | string The unique identifier for the tenant that made the request to the Service. |
| token | string The execution token needed for any callback responses from the Service. |
Success
{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listeningEventValue": {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}, - "tenantId": "string",
- "token": "string"
}"string"Used to add a listener to the state stateId from the details in the request body
| stateId required | string |
The details of the state listener used to set up the new listener
| annotations | object |
| callbackUri | string |
| listenType | string |
| stateId | string |
Success
{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "callbackUri": "string",
- "listenType": "string",
- "stateId": "string"
}{- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "callbackUri": "string",
- "id": "string",
- "listenType": "string",
- "stateId": "string"
}Used to remove the listener on the state stateId with the id listenerId
| stateId required | string The unique identifier of the Flow state. |
| listenerId required | string The unique identifier of the listener. |
Success
Used to import a state into the tenant from JSON
The JSON of the state to be imported.
Success
"string"Used to export a state from the tenant into JSON.
| stateId required | string The unique identifier of the Flow state. |
Success
"string"Used to check if a change has occurred to the state, by comparing the current state token of the state with the provided one
| stateId required | string <uuid> The unique identifier of the Flow state. |
| stateToken required | string <uuid> The state token to compare to the current state token of the Flow state |
Success
trueUsed to get the value for the id provided in the flow state
| stateId required | string <uuid> The unique identifier of the Flow state. |
| id required | string <uuid> The unique identifier of the Flow value. |
Success
{- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}Used to get the value for the name provided in the flow state
| stateId required | string <uuid> The unique identifier of the Flow state. |
| name required | string The name of the Flow value. |
Success
{- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}Used to get all the values in the flow state. This endpoint requires a runtime authentication token, which means it can only be used with non-public flows.
| stateId required | string <uuid> The unique identifier of the Flow state. |
Success
[- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]Used to set values in the flow state with the given data. This endpoint requires a runtime authentication token, which means it can only be used with non-public flows.
| stateId required | string <uuid> The unique identifier of the Flow state. |
The new details for a list of values.
| contentType | string The content type of the value you are passing into the flow. The content types are specified by the ContentType enumeration. |
| contentValue | string The actual content value being assigned to the value in the flow. This property should be used for all "primitive", non-typed values in your flow. For example, if you are referencing a value called "First Name", this would be the value you actually want to assign to it: e.g. "Steve". |
| developerName | string |
| objectData | Array of objects (ObjectAPI) |
| typeElementDeveloperName | string The developer name for the object type of the value in the flow being assigned. |
| typeElementId | string The unique identifier for the object type of the value in the flow being assigned. Using the typeElementId ensures that your player is guaranteed to be referencing the correct object type. If you use the typeElementDeveloperName property, a change in the type name can break the integration. We ask that you specify the type as we may in future support type casting and we therefore want to know the type you're passing in so we can validate it is correct before mapping to the super type. |
| typeElementPropertyDeveloperName | string The developer name for the object property of the value in the flow being assigned. |
| typeElementPropertyId | string The unique identifier for the object property of the value in the flow being assigned. Typed objects all have properties. Using the typeElementPropertyId allows you to assign a property in an object value as opposed to the whole value. As with the other identifier references, using the typeElementPropertyId ensures that your player is guaranteed to be assigning the correct value. Using the typeElementPropertyDeveloperName makes it possible to break the integration if the author changes the developerName of a property in the type. |
| valueElementId | string The unique identifier for the value in the flow being assigned. Using the id to reference the value ensures that your player is guaranteed to be assigning the correct value. If you reference a value by developerName, it is possible for the author to break integration points simply by changing the name of the value. You must provide an 'id' or a 'developerName'. |
Success
[- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
][- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
]| authorization | object (AuthorizationAPI) |
| command | object (CommandRequestAPI) |
| configurationValues | Array of objects (EngineValueAPI) The configuration information that comes from the service element. |
| culture | object (CultureAPI) |
| listFilter | object (ListFilterAPI) |
| objectData | Array of objects (ObjectAPI) The list of objects to insert, update or delete. |
| objectDataType | object (ObjectDataTypeAPI) |
| stateId | string The state id that allows us to make the correct version references. |
| token | string The unique token for this data job. The token can be used to help the plugin cache multiple data calls. If the token is provided, we can match it up with a previous data request - if we choose to cache it. |
| typeElementBindingId | string The Id for the service element associated with this object data. The service element will give us the connection settings and allow us to validate various info around the type. |
Success
{- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "command": {
- "commandType": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "comparisonType": "string",
- "filterByProvidedObjects": true,
- "id": "string",
- "limit": 0,
- "listFilters": [
- {
- "comparisonType": "string",
- "listFilters": [
- { }
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}
], - "offset": 0,
- "offsetToken": "string",
- "orderBy": [
- {
- "columnName": "string",
- "direction": "string"
}
], - "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string",
- "searchCriteria": [
- {
- "columnName": "string"
}
], - "where": [
- {
- "columnName": "string",
- "contentValue": "string",
- "criteriaType": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "value": "string"
}
]
}, - "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "objectDataType": {
- "developerName": "string",
- "properties": [
- {
- "developerName": "string",
- "list": [
- { }
]
}
], - "typeElementId": "string"
}, - "stateId": "string",
- "token": "string",
- "typeElementBindingId": "string"
}{- "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "hasMoreResults": true,
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "offsetToken": "string",
- "stateId": "string"
}| authorization | object (AuthorizationAPI) |
| configurationValues | Array of objects (EngineValueAPI) The configuration information that comes from the service element. |
| culture | object (CultureAPI) |
| listFilter | object (FileListFilterAPI) |
| resourceFile | string The resouce path to use when sourcing a specific file. |
| resourcePath | string The resouce path to use when sourcing the files. |
| serviceElementId | string The service to grab the files from. |
| stateId | string The state id that allows us to make the correct version references. |
| token | string The unique token for this data job. The token can be used to help the plugin cache multiple data calls. If the token is provided, we can match it up with a previous data request - if we choose to cache it. |
Success
{- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "limit": 0,
- "offset": 0,
- "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string"
}, - "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string",
- "stateId": "string",
- "token": "string"
}{- "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "hasMoreResults": true,
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "offsetToken": "string",
- "stateId": "string"
}{- "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "hasMoreResults": true,
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "offsetToken": "string",
- "stateId": "string"
}| authorization | object (AuthorizationAPI) |
| configurationValues | Array of objects (EngineValueAPI) The configuration information that comes from the service element. |
| culture | object (CultureAPI) |
| listFilter | object (FileListFilterAPI) |
| resourceFile | string The resouce path to use when sourcing a specific file. |
| resourcePath | string The resouce path to use when sourcing the files. |
| serviceElementId | string The service to grab the files from. |
| stateId | string The state id that allows us to make the correct version references. |
| token | string The unique token for this data job. The token can be used to help the plugin cache multiple data calls. If the token is provided, we can match it up with a previous data request - if we choose to cache it. |
Success
{- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "authenticationId": "string"
}
], - "runningAuthenticationId": "string",
- "users": [
- {
- "attribute": "string",
- "authenticationId": "string",
- "runningUser": true
}
]
}, - "configurationValues": [
- {
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "typeElementDeveloperName": "string",
- "typeElementId": "string",
- "typeElementPropertyDeveloperName": "string",
- "typeElementPropertyId": "string",
- "valueElementId": "string"
}
], - "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "listFilter": {
- "limit": 0,
- "offset": 0,
- "orderByDirectionType": "string",
- "orderByPropertyDeveloperName": "string",
- "search": "string"
}, - "resourceFile": "string",
- "resourcePath": "string",
- "serviceElementId": "string",
- "stateId": "string",
- "token": "string"
}{- "culture": {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}, - "hasMoreResults": true,
- "objectData": [
- {
- "developerName": "string",
- "externalId": "string",
- "internalId": "string",
- "isSelected": true,
- "order": 0,
- "properties": [
- {
- "contentFormat": "string",
- "contentType": "string",
- "contentValue": "string",
- "developerName": "string",
- "objectData": [
- { }
], - "typeElementId": "string",
- "typeElementPropertyId": "string"
}
], - "typeElementBindingDeveloperName": "string",
- "typeElementId": "string"
}
], - "offsetToken": "string",
- "stateId": "string"
}Get the metadata for every request sent to a Service
| pageSize | integer <int32> Default: 10 The number of service requests to return |
| page | integer <int32> Default: 1 The current page of service requests |
| orderBy | string Default: "createdAt" Property to order service requests by, defaults to "createdAt" |
| orderDirection | string Default: "DESC" ASC or DESC, defaults to DESC |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "attributes": {
- "property1": { },
- "property2": { }
}, - "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "failures": [
- {
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "problem": {
- "action": "string",
- "invokeType": "string",
- "kind": "api",
- "message": "string",
- "responseBody": "string",
- "responseHeaders": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "statusCode": 0,
- "uri": "string"
}, - "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "id": "string",
- "method": "string",
- "responses": [
- {
- "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "stateId": "string",
- "tenantId": "string",
- "uri": "string"
}
]
}Get the metadata for a specific request sent to a service
| id required | string <uuid> |
Success
{- "attributes": {
- "property1": { },
- "property2": { }
}, - "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "failures": [
- {
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "problem": {
- "action": "string",
- "invokeType": "string",
- "kind": "api",
- "message": "string",
- "responseBody": "string",
- "responseHeaders": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "statusCode": 0,
- "uri": "string"
}, - "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "id": "string",
- "method": "string",
- "responses": [
- {
- "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "stateId": "string",
- "tenantId": "string",
- "uri": "string"
}Get the metadata for every request sent to a Service from a specific Flow
| id required | string <uuid> The flow ID |
| pageSize | integer <int32> Default: 10 The number of service requests to return |
| page | integer <int32> Default: 1 The current page of service requests |
| orderBy | string Default: "createdAt" Property to order service requests by, defaults to "createdAt" |
| orderDirection | string Default: "DESC" ASC or DESC, defaults to DESC |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "attributes": {
- "property1": { },
- "property2": { }
}, - "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "failures": [
- {
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "problem": {
- "action": "string",
- "invokeType": "string",
- "kind": "api",
- "message": "string",
- "responseBody": "string",
- "responseHeaders": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "statusCode": 0,
- "uri": "string"
}, - "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "id": "string",
- "method": "string",
- "responses": [
- {
- "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "stateId": "string",
- "tenantId": "string",
- "uri": "string"
}
]
}Get the metadata for every request sent to a Service from a specific version of a Flow
| id required | string <uuid> The flow ID |
| version required | string <uuid> The flow version |
| pageSize | integer <int32> Default: 10 The number of service requests to return |
| page | integer <int32> Default: 1 The current page of service requests |
| orderBy | string Default: "createdAt" Property to order service requests by, defaults to "createdAt" |
| orderDirection | string Default: "DESC" ASC or DESC, defaults to DESC |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "attributes": {
- "property1": { },
- "property2": { }
}, - "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "failures": [
- {
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "problem": {
- "action": "string",
- "invokeType": "string",
- "kind": "api",
- "message": "string",
- "responseBody": "string",
- "responseHeaders": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "statusCode": 0,
- "uri": "string"
}, - "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "id": "string",
- "method": "string",
- "responses": [
- {
- "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "stateId": "string",
- "tenantId": "string",
- "uri": "string"
}
]
}Get the metadata for every request sent to a Service from a specific State
| id required | string <uuid> The state ID |
| pageSize | integer <int32> Default: 10 The number of service requests to return |
| page | integer <int32> Default: 1 The current page of service requests |
| orderBy | string Default: "createdAt" Property to order service requests by, defaults to "createdAt" |
| orderDirection | string Default: "DESC" ASC or DESC, defaults to DESC |
Success
{- "_links": {
- "property1": "string",
- "property2": "string"
}, - "_meta": {
- "property1": { },
- "property2": { }
}, - "items": [
- {
- "attributes": {
- "property1": { },
- "property2": { }
}, - "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "failures": [
- {
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "problem": {
- "action": "string",
- "invokeType": "string",
- "kind": "api",
- "message": "string",
- "responseBody": "string",
- "responseHeaders": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "statusCode": 0,
- "uri": "string"
}, - "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "id": "string",
- "method": "string",
- "responses": [
- {
- "content": "string",
- "createdAt": "2020-02-18T14:27:32Z",
- "id": "string",
- "serviceRequestId": "string",
- "stateId": "string",
- "tenantId": "string"
}
], - "stateId": "string",
- "tenantId": "string",
- "uri": "string"
}
]
}The content value culture object represents a language or brand supported by the tenant.
Content value cultures are used to specify the language/brand options that are available for the tenant. By
default all tenants have a content value culture for USA (English). However, for multi-national/language
use-cases, others can be specified. They follow the ISO conventions for language. However, the platform also
supports a fourth variation on the standard ISO properties; this is brand. As a result, content
value culture objects can also be used to specify white-labelling or single language variations on flow content.
[- {
- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}
]Used to create new content value cultures or update existing ones.
| brand | string The brand for the culture. |
| country | string The country for the culture. |
| developerName | string The developer name for the culture. |
| developerSummary | string The developer summary for the culture. |
| id | string The id for the culture. |
| language | string The language for the culture. |
| variant | string The variant for the culture. |
Success
{- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}{- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}Used to get an existing content value culture.
| id required | string <uuid> The unique identifier for the content value culture |
Success
{- "brand": "string",
- "country": "string",
- "developerName": "string",
- "developerSummary": "string",
- "id": "string",
- "language": "string",
- "variant": "string"
}The flow translation object provides all of the content elements and properties in a flow that can be translated.
The flow translation object provides every element in the flow that is available for translation. It therefore provides all of the content in the flow, regardless of whether or not the elements are shared (such as value and page elements) or specific to the flow (such as map or navigation elements). The flow translation object also includes additional properties to help translators identify the purpose/location of the content being translated.
Used to filter existing flow objects that are available for translation.
The filter can take the following formats:
developerName eq '{developer_name}': Filter the list of flows where the developerName property exactly matches the provided developer name (case insensitive)substringof(developerName, '{developer_name}'): Filter the list of flows where the developerName property partially matches the provided developer name (case insensitive)| filter | string The filter used for querying |
Success
[- {
- "alertEmail": "string",
- "allowJumping": true,
- "authorization": {
- "globalAuthenticationType": "string",
- "groups": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "serviceElementId": "string"
}
], - "locations": [
- {
- "attribute": "string",
- "developerName": "string",
- "developerSummary": "string",
- "valueElementToReferenceId": {
- "command": "string",
- "id": "string",
- "typeElementPropertyId": "string"
}
}
], - "serviceElementId": "string",
- "showPagesAsReadOnly": true,
- "streamBehaviourType": "string",
- "users": [
- {
- "attribute": "string",
- "attributeLabel": "string",
- "authenticationId": "string",
- "developerSummary": "string",
- "friendlyName": "string",
- "runningUser": true,
- "serviceElementId": "string"
}
]
}, - "comment": "string",
- "dateCreated": "2020-02-18T14:27:32Z",
- "dateModified": "2020-02-18T14:27:32Z",
- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": {
- "id": "string",
- "versionId": "string"
}, - "isActive": true,
- "isDefault": true,
- "restrictions": {
- "access": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}, - "execution": {
- "continents": [
- "string"
], - "countries": [
- "string"
], - "enabled": true
}
}, - "startMapElementId": "string",
- "stateExpirationLength": 0,
- "whoCreated": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoModified": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}, - "whoOwner": {
- "email": "string",
- "firstName": "string",
- "id": "string",
- "lastName": "string"
}
}
]{- "developerName": "string",
- "developerSummary": "string",
- "editingToken": "string",
- "id": "string",
- "mapElements": [
- {
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "notAuthorizedMessageContentValueId": "string",
- "outcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "labelContentValueId": "string",
- "nextMapElementId": "string"
}
], - "postUpdateMessageContentValueId": "string",
- "statusMessageContentValueId": "string",
- "userContentContentValueId": "string"
}
], - "navigationElements": [
- {
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "labelContentValueId": "string",
- "navigationItems": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "labelContentValueId": "string",
- "locationMapElementId": "string",
- "navigationItems": [
- { }
]
}
]
}
], - "pageElements": [
- {
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "labelContentValueId": "string",
- "pageComponents": [
- {
- "columns": [
- {
- "labelContentValueId": "string"
}
], - "componentType": "string",
- "contentContentValueId": "string",
- "developerName": "string",
- "helpInfoContentValueId": "string",
- "hintValueContentValueId": "string",
- "labelContentValueId": "string",
- "pageContainerDeveloperName": "string"
}
], - "pageContainers": [
- {
- "containerType": "string",
- "developerName": "string",
- "labelContentValueId": "string",
- "pageContainers": [
- { }
]
}
]
}
], - "startMapElementId": "string",
- "typeElements": [
- {
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormatContentValueId": "string",
- "developerName": "string",
- "id": "string"
}
]
}
], - "valueElements": [
- {
- "contentFormatContentValueId": "string",
- "contentType": "string",
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "defaultContentValueContentValueId": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string"
}
]
}The map element translation object provides all of the content properties in a map element that can be translated.
The map element translation object also includes additional properties to help translators identity the purpose/location of the content being translated.
| editingToken required | string <uuid> |
| flow required | string <uuid> |
| contentValueDocument | object (ContentValueDocumentAPI) |
| developerName | string |
| developerSummary | string |
| elementType | string |
| id | string |
| notAuthorizedMessageContentValueId | string |
| outcomes | Array of objects (OutcomeTranslationResponseAPI) |
| postUpdateMessageContentValueId | string |
| statusMessageContentValueId | string |
| userContentContentValueId | string |
Success
{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "notAuthorizedMessageContentValueId": "string",
- "outcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "labelContentValueId": "string",
- "nextMapElementId": "string"
}
], - "postUpdateMessageContentValueId": "string",
- "statusMessageContentValueId": "string",
- "userContentContentValueId": "string"
}{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "notAuthorizedMessageContentValueId": "string",
- "outcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "labelContentValueId": "string",
- "nextMapElementId": "string"
}
], - "postUpdateMessageContentValueId": "string",
- "statusMessageContentValueId": "string",
- "userContentContentValueId": "string"
}| editingToken required | string <uuid> |
| flow required | string <uuid> |
| id required | string <uuid> |
Success
{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "notAuthorizedMessageContentValueId": "string",
- "outcomes": [
- {
- "developerName": "string",
- "developerSummary": "string",
- "labelContentValueId": "string",
- "nextMapElementId": "string"
}
], - "postUpdateMessageContentValueId": "string",
- "statusMessageContentValueId": "string",
- "userContentContentValueId": "string"
}The page element translation object provides all of the content properties in a page element that can be translated.
The page element translation object also includes additional properties to help translators identify the purpose/location of the content being translated.
| contentValueDocument | object (ContentValueDocumentAPI) |
| developerName | string |
| developerSummary | string |
| elementType | string |
| id | string |
| labelContentValueId | string |
| pageComponents | Array of objects (PageComponentTranslationResponseAPI) |
| pageContainers | Array of objects (PageContainerTranslationResponseAPI) |
Success
{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "labelContentValueId": "string",
- "pageComponents": [
- {
- "columns": [
- {
- "labelContentValueId": "string"
}
], - "componentType": "string",
- "contentContentValueId": "string",
- "developerName": "string",
- "helpInfoContentValueId": "string",
- "hintValueContentValueId": "string",
- "labelContentValueId": "string",
- "pageContainerDeveloperName": "string"
}
], - "pageContainers": [
- {
- "containerType": "string",
- "developerName": "string",
- "labelContentValueId": "string",
- "pageContainers": [
- { }
]
}
]
}{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "labelContentValueId": "string",
- "pageComponents": [
- {
- "columns": [
- {
- "labelContentValueId": "string"
}
], - "componentType": "string",
- "contentContentValueId": "string",
- "developerName": "string",
- "helpInfoContentValueId": "string",
- "hintValueContentValueId": "string",
- "labelContentValueId": "string",
- "pageContainerDeveloperName": "string"
}
], - "pageContainers": [
- {
- "containerType": "string",
- "developerName": "string",
- "labelContentValueId": "string",
- "pageContainers": [
- { }
]
}
]
}{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "labelContentValueId": "string",
- "pageComponents": [
- {
- "columns": [
- {
- "labelContentValueId": "string"
}
], - "componentType": "string",
- "contentContentValueId": "string",
- "developerName": "string",
- "helpInfoContentValueId": "string",
- "hintValueContentValueId": "string",
- "labelContentValueId": "string",
- "pageContainerDeveloperName": "string"
}
], - "pageContainers": [
- {
- "containerType": "string",
- "developerName": "string",
- "labelContentValueId": "string",
- "pageContainers": [
- { }
]
}
]
}When building flows on the platform, all “content” is automatically separated from “logic”. This means that all flows are automatically ready for internationalization. The result being that you can write one flow, but adjust the content accordingly for each content value culture needed.
The Translate APIs allow builders to manage content translations for all flows and elements.
The type element translation object provides all of the content properties in a type element that can be translated.
The type element translation object also includes additional properties to help translators identify the purpose/location of the content being translated.
| contentValueDocument | object (ContentValueDocumentAPI) |
| developerName | string |
| developerSummary | string |
| elementType | string |
| id | string |
| properties | Array of objects (PropertyTranslationResponseAPI) |
Success
{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormatContentValueId": "string",
- "developerName": "string",
- "id": "string"
}
]
}{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormatContentValueId": "string",
- "developerName": "string",
- "id": "string"
}
]
}{- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string",
- "properties": [
- {
- "contentFormatContentValueId": "string",
- "developerName": "string",
- "id": "string"
}
]
}The value element translation object provides all of the content properties in a value element that can be translated.
The value element translation object also includes additional properties to help translators identify the purpose/location of the content being translated.
| contentFormatContentValueId | string |
| contentType | string |
| contentValueDocument | object (ContentValueDocumentAPI) |
| defaultContentValueContentValueId | string |
| developerName | string |
| developerSummary | string |
| elementType | string |
| id | string |
Success
{- "contentFormatContentValueId": "string",
- "contentType": "string",
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "defaultContentValueContentValueId": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string"
}{- "contentFormatContentValueId": "string",
- "contentType": "string",
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "defaultContentValueContentValueId": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string"
}{- "contentFormatContentValueId": "string",
- "contentType": "string",
- "contentValueDocument": {
- "translations": {
- "property1": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "contentValues": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "defaultContentValueContentValueId": "string",
- "developerName": "string",
- "developerSummary": "string",
- "elementType": "string",
- "id": "string"
}